From 89e5c05cff63edf379335c4251a50e92694ff883 Mon Sep 17 00:00:00 2001 From: Dylan Greene Date: Sat, 14 Sep 2013 15:35:17 -0400 Subject: [PATCH] update the docs to make them more readable --- readme.md | 126 +++++++++++++++++++++++++++++------------------------- 1 file changed, 67 insertions(+), 59 deletions(-) diff --git a/readme.md b/readme.md index 084645c..b11537d 100644 --- a/readme.md +++ b/readme.md @@ -10,88 +10,96 @@ ## Usage - var RSS = require('rss'); +```js +var RSS = require('rss'); - /* lets create an rss feed */ - var feed = new RSS({ - title: 'title', - description: 'description', - feed_url: 'http://example.com/rss.xml', - site_url: 'http://example.com', - image_url: 'http://example.com/icon.png', - docs: 'http://example.com/rss/docs.html', - author: 'Dylan Greene', - managingEditor: 'Dylan Greene', - webMaster: 'Dylan Greene', - copyright: '2013 Dylan Greene', - language: 'en', - categories: ['Category 1','Category 2','Category 3'], - pubDate: 'May 20, 2012 04:00:00 GMT', - ttl: '60' - }); - - /* loop over data and add to feed */ - feed.item({ - title: 'item title', - description: 'use this for the content. It can include html.', - url: 'http://example.com/article4?this&that', // link to the item - guid: '1123', // optional - defaults to url - categories: ['Category 1','Category 2','Category 3','Category 4'], // optional - array of item categories - author: 'Guest Author', // optional - defaults to feed author property - date: 'May 27, 2012' // any format that js Date can parse. - enclosure : {url:'...', file:'path-to-file'} // optional +/* lets create an rss feed */ +var feed = new RSS({ + title: 'title', + description: 'description', + feed_url: 'http://example.com/rss.xml', + site_url: 'http://example.com', + image_url: 'http://example.com/icon.png', + docs: 'http://example.com/rss/docs.html', + author: 'Dylan Greene', + managingEditor: 'Dylan Greene', + webMaster: 'Dylan Greene', + copyright: '2013 Dylan Greene', + language: 'en', + categories: ['Category 1','Category 2','Category 3'], + pubDate: 'May 20, 2012 04:00:00 GMT', + ttl: '60' }); - // cache the xml - var xml = feed.xml(); +/* loop over data and add to feed */ +feed.item({ + title: 'item title', + description: 'use this for the content. It can include html.', + url: 'http://example.com/article4?this&that', // link to the item + guid: '1123', // optional - defaults to url + categories: ['Category 1','Category 2','Category 3','Category 4'], // optional - array of item categories + author: 'Guest Author', // optional - defaults to feed author property + date: 'May 27, 2012' // any format that js Date can parse. + enclosure : {url:'...', file:'path-to-file'} // optional +}); + +// cache the xml +var xml = feed.xml(); +``` ### Feed Options - * _title_ Title of your site or feed - * _description_ Optional. Short description of the feed. - * _generator_ Optional. Feed generator. - * _feed_url_ Url to the rss feed. - * _site_url_ Url to the site that the feed is for. - * _image_url_ Optional. Small image for feed readers to use. - * _docs_ Optional. Url to documentation on this feed. - * _author_ Who owns this feed. - * _managingEditor_ Optional. Who manages content in this feed. - * _webMaster_ Optional. Who manages feed availability and technical support. - * _copyright_ Optional. Copyright information for this feed. - * _language_ Optional. The language of the content of this feed. - * _categories_ Optional. One or more categories this feed belongs to. - * _pubDate_ Optional. The publication date for content in the feed - * _ttl_ Optional. Number of minutes feed can be cached before refreshing from source. + * `title` **string** Title of your site or feed + * `description` _optional_ **string** A short description of the feed. + * `generator` _optional_ **string** Feed generator. + * `feed_url` **url string** Url to the rss feed. + * `site_url` **url string** Url to the site that the feed is for. + * `image_url` _optional_ **url string* Small image for feed readers to use. + * `docs` _optional_ **url string** Url to documentation on this feed. + * `author` **string** Who owns this feed. + * `managingEditor` _optional_ **string** Who manages content in this feed. + * `webMaster` _optional_ **string** Who manages feed availability and technical support. + * `copyright` _optional_ **string** Copyright information for this feed. + * `language` _optional_ **string** The language of the content of this feed. + * `categories` _optional_ **array of strings** One or more categories this feed belongs to. + * `pubDate` _optional_ **Date object or date string** The publication date for content in the feed + * `ttl` _optional_ **integer** Number of minutes feed can be cached before refreshing from source. ### Item Options In RSS an item can be used for a blog entry, project update, log entry, etc. Your rss feed -an have any number of items. Ten to tenty is usually good. +an have any number of items. Ten to twenty is usually good. - * _title_ Title of this particular item. - * _description_ Content for the item. Can contain html but link and image urls must include the server name. - (Note: I might change this to content in the next release.) - * _url_ Url to the item. This could be a blog entry. - * _guid_ A unique string feed readers use to know if an item is new or has already been seen. + * `title` **string** Title of this particular item. + * `description` **string** Content for the item. Can contain html but link and image urls must be absolute path including hostname. + * `url` **url string** Url to the item. This could be a blog entry. + * `guid` **unique string** A unique string feed readers use to know if an item is new or has already been seen. If you use a guid never change it. If you don't provide a guid then your item urls must be unique. - * _categories_ Optional. If provided, each array item will be added as a category element - * _author_ Optional. If included it is the name of the item's creator. + * `categories` _optional_ **array of strings** If provided, each array item will be added as a category element + * `author` _optional_ *string* If included it is the name of the item's creator. If not provided the item author will be the same as the feed author. This is typical except on multi-author blogs. - * _date_ The date and time of when the item was created. Feed + * `date` **Date object or date string** The date and time of when the item was created. Feed readers use this to determine the sort order. Some readers will also use it to determine if the content should be presented as unread. ### Methods - * _item(item_options)_ - add an rss item, article, entry etc. - * _xml([indent])_ - return the xml. If you pass in true it will use four spaces for indenting. If you prefer - tabs use \t instead of true. +#### `item(item_options)` + +Add an rss item/article. + +#### `xml([indent])` + +Return the xml. + +If you pass in `true` it will use four spaces for indenting. If you prefer + tabs pass in `\t` instead of true, or a two space string for two space tabs. ## Tests - Mocha tests are included. Use `npm test` to run the tests. +Tests included use Mocha. Use `npm test` to run the tests. $ npm test