cdnjs/node_modules/rss/package.json

{
  "name": "rss",
  "version": "1.0.0",
  "description": "RSS feed generator. A really simple API to add RSS feeds to any project.",
  "homepage": "http://github.com/dylang/node-rss",
  "author": {
    "name": "Dylan Greene",
    "email": "dylang@gmail.com"
  },
  "contributors": [
    {
      "name": "Dylan Greene",
      "email": "dylang@gmail.com"
    },
    {
      "name": "Xavier Damman",
      "email": "xdamman@gmail.com"
    },
    {
      "name": "Michael R. Lange"
    },
    {
      "name": "Victor Jonsson"
    },
    {
      "name": "Danny Graham"
    },
    {
      "name": "Patrick Garman",
      "email": "contact@pmgarman.me"
    },
    {
      "name": "Fred Morstatter"
    },
    {
      "name": "Eric Vantillard",
      "email": "eric.vantillard@evaxion.fr"
    }
  ],
  "repository": {
    "type": "git",
    "url": "http://github.com/dylang/node-rss"
  },
  "bugs": {
    "url": "http://github.com/dylang/node-rss/issues"
  },
  "dependencies": {
    "mime": "^1.2.11",
    "xml": "^1.0.0"
  },
  "devDependencies": {
    "chai": "^1.9.1",
    "mocha": "^1.21.4",
    "q": "^1.0.0",
    "xml2js": "^0.4.1"
  },
  "main": "lib/rss.js",
  "scripts": {
    "test": "mocha --reporter spec"
  },
  "licenses": "MIT",
  "readme": "# RSS for Node [![Build Status](https://api.travis-ci.org/dylang/node-rss.svg)](http://travis-ci.org/dylang/node-rss)\n\n  [![NPM](https://nodei.co/npm/rss.png?downloads=true)](https://nodei.co/npm/rss/)\n\n> Fast and simple RSS generator/builder for Node projects. Supports enclosures and GeoRSS.\n\n## Install\n\n    $ npm install rss\n\n## Usage\n\n### Create a new feed\n\n```js\nvar RSS = require('rss');\n\nvar feed = new RSS(feedOptions);\n```\n\n#### `feedOptions`\n\n * `title` **string** Title of your site or feed\n * `description` _optional_ **string** A short description of the feed.\n * `generator` _optional_  **string** Feed generator.\n * `feed_url` **url string** Url to the rss feed.\n * `site_url` **url string** Url to the site that the feed is for.\n * `image_url` _optional_  **url string* Small image for feed readers to use.\n * `docs` _optional_ **url string** Url to documentation on this feed.\n * `managingEditor` _optional_ **string** Who manages content in this feed.\n * `webMaster` _optional_ **string** Who manages feed availability and technical support.\n * `copyright` _optional_ **string** Copyright information for this feed.\n * `language` _optional_ **string**  The language of the content of this feed.\n * `categories` _optional_ **array of strings**  One or more categories this feed belongs to.\n * `pubDate` _optional_ **Date object or date string** The publication date for content in the feed\n * `ttl` _optional_ **integer** Number of minutes feed can be cached before refreshing from source.\n * `hub` _optional_ **PubSubHubbub hub url** Where is the PubSubHubb hub located.\n\n### Add items to a feed\n\nAn item can be used for a blog entry, project update, log entry, etc.  Your RSS feed\ncan have any number of items. Most feeds use 20 or fewer items.\n\n```js\nfeed.item(itemOptions);\n```\n\n#### itemOptions\n\n * `title` **string** Title of this particular item.\n * `description` **string** Content for the item.  Can contain html but link and image urls must be absolute path including hostname.\n * `url` **url string** Url to the item. This could be a blog entry.\n * `guid` **unique string** A unique string feed readers use to know if an item is new or has already been seen.\n If you use a guid never change it.  If you don't provide a guid then your item urls must\n be unique.\n * `categories` _optional_ **array of strings** If provided, each array item will be added as a category element\n * `author` _optional_  **string**  If included it is the name of the item's creator.\n If not provided the item author will be the same as the feed author.  This is typical\n except on multi-author blogs.\n * `date` **Date object or date string** The date and time of when the item was created.  Feed\n readers use this to determine the sort order. Some readers will also use it to determine\n if the content should be presented as unread.\n * `lat` _optional_ **number** The latitude coordinate of the item.\n * `long` _optional_ **number** The longitude coordinate of the item.\n\n#### Feed XML\n\n```js\nvar xml = feed.xml(indent);\n```\n\nThis returns the XML as a string.\n\n`indent` _optional_ **string** What to use as a tab. Defaults to no tabs (compressed).\n For example you can use `'\\t'` for tab character, or `'  '` for two-space tabs.\n\n## Example Usage\n\n```js\nvar RSS = require('rss');\n\n/* lets create an rss feed */\nvar feed = new RSS({\n    title: 'title',\n    description: 'description',\n    feed_url: 'http://example.com/rss.xml',\n    site_url: 'http://example.com',\n    image_url: 'http://example.com/icon.png',\n    docs: 'http://example.com/rss/docs.html',\n    managingEditor: 'Dylan Greene',\n    webMaster: 'Dylan Greene',\n    copyright: '2013 Dylan Greene',\n    language: 'en',\n    categories: ['Category 1','Category 2','Category 3'],\n    pubDate: 'May 20, 2012 04:00:00 GMT',\n    ttl: '60'\n});\n\n/* loop over data and add to feed */\nfeed.item({\n    title:  'item title',\n    description: 'use this for the content. It can include html.',\n    url: 'http://example.com/article4?this&that', // link to the item\n    guid: '1123', // optional - defaults to url\n    categories: ['Category 1','Category 2','Category 3','Category 4'], // optional - array of item categories\n    author: 'Guest Author', // optional - defaults to feed author property\n    date: 'May 27, 2012', // any format that js Date can parse.\n    lat: 33.417974, //optional latitude field for GeoRSS\n    long: -111.933231, //optional longitude field for GeoRSS\n    enclosure: {url:'...', file:'path-to-file'} // optional enclosure\n});\n\n// cache the xml to send to clients\nvar xml = feed.xml();\n```\n\n## Tests\n\nTests included use Mocha. Use `npm test` to run the tests.\n\n    $ npm test\n\n## Notes\n * You do not need to escape anything. This module will escape characters when necessary.\n * This module is very fast but you might as well cache the output of xml() and serve\n it until something changes.\n\n# History\n\nI started this module *years* ago (April 2011) because there weren't any Node modules\nfor creating RSS. [Nearly 50 modules](https://npmjs.org/browse/depended/rss)\nuse RSS, as well as many web sites and the popular [Ghost publishing platform](https://ghost.org/).\n\n# Contributing\n\nContributions to the project are welcome. Feel free to fork and improve.\nI do my best accept pull requests in a timely manor, especially when tests and updated docs\nare included.\n\n# License\n\n(The MIT License)\n\nCopyright (c) 2011-2014 Dylan Greene <dylang@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
  "readmeFilename": "readme.md",
  "_id": "rss@1.0.0",
  "dist": {
    "shasum": "9bd592ac8288a2507c606f93cb4d543fffc2c1e7"
  },
  "_from": "rss@~1.0",
  "_resolved": "https://registry.npmjs.org/rss/-/rss-1.0.0.tgz"
}