add customFields docs

rbren · rbren · commit c418d03584a9 · 2017-06-21T19:58:19.000Z
diff --git a/README.md b/README.md
@@ -58,6 +58,8 @@ parser.parseURL('https://reddit.com/.rss', {maxRedirects: 3}, function(err, pars
 ```
 
 ### Custom Fields
+If your RSS feed contains fields that aren't currently returned, you can access them using the `customFields` option.
+
 ```js
 var options = {
   customFields: {
@@ -74,6 +76,18 @@ parser.parseURL('https://www.reddit.com/.rss', options, function(err, parsed) {
 })
 ```
 
+To rename fields, you can pass in an array with two items, in the format `[fromField, toField]`:
+
+```js
+var options = {
+  customFields: {
+    item: [
+      ['dc:coAuthor', 'coAuthor'],
+    ]
+  }
+}
+```
+
 ## Contributing
 Contributions welcome!
 
