added GeoRSS support thanks to @fredzilla. Fixes #15.

This commit is contained in:
Dylan Greene
2013-09-14 16:29:34 -04:00
parent 05b63b7ece
commit a73e525251
4 changed files with 77 additions and 44 deletions

View File

@@ -2,7 +2,7 @@
[![NPM](https://nodei.co/npm/rss.png?downloads=true)](https://nodei.co/npm/rss/)
> Fast and simple RSS generator/builder for Node projects.
> Fast and simple RSS generator/builder for Node projects. Supports enclosures and GeoRSS.
## Install
@@ -34,7 +34,6 @@ var feed = new RSS(feedOptions);
* `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
* `georss` _optional_ **boolean** Whether to make the feed a GeoRSS feed. Default is `false`.
* `ttl` _optional_ **integer** Number of minutes feed can be cached before refreshing from source.
### Add items to a feed
@@ -61,8 +60,8 @@ feed.item(itemOptions);
* `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.
* `lat` _required if is a GeoRSS feed_ **number** The latitude coordinate of the item.
* `lng` _required if is a GeoRSS feed_ **number** The longitude coordinate of the item.
* `lat` _optional_ **number** The latitude coordinate of the item.
* `long` _optional_ **number** The longitude coordinate of the item.
#### Feed XML
@@ -82,22 +81,21 @@ 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',
georss: true, //set this flag if you wish for the feed to be returned in GeoRSS. A lat/lng field will be expected for each item.
ttl: '60'
});
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({
@@ -108,9 +106,9 @@ feed.item({
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.
// lat: 33.417974, //latitude field. Provide if georss is true in the feed setup.
// lng: -111.933231, //longitude field. Provide if georss is true in the feed setup.
enclosure : {url:'...', file:'path-to-file'} // optional
lat: 33.417974, //optional latitude field for GeoRSS
long: -111.933231, //optional longitude field for GeoRSS
enclosure : {url:'...', file:'path-to-file'} // optional enclosure
});
// cache the xml to send to clients