website/node_modules/feed/README.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

Feed for Node.js

Feed is a RSS 2.0, JSON Feed 1.0, and Atom 1.0 generator for Node.js, making content syndication simple and intuitive!

Installation

$ npm install feed

Features

• Pure JavaScript
• Support for Atom 1.0 and RSS 2.0
• Lightweight - Only 1 dependency!

Quick Start

First, add the module:

const Feed = require('feed')

Insert feed-specific information:

let feed = new Feed({
  title: 'Feed Title',
  description: 'This is my personal feed!',
  id: 'http://example.com/',
  link: 'http://example.com/',
  image: 'http://example.com/image.png',
  favicon: 'http://example.com/favicon.ico',
  copyright: 'All rights reserved 2013, John Doe',
  updated: new Date(2013, 06, 14), // optional, default = today
  generator: 'awesome', // optional, default = 'Feed for Node.js'
  feedLinks: {
    json: 'https://example.com/json',
    atom: 'https://example.com/atom',
  },
  author: {
    name: 'John Doe',
    email: '[e-mail]',
    link: 'https://example.com/johndoe'
  }
})

Insert items using the item function:

posts.forEach(post => {
  feed.addItem({
    title: post.title,
    id: post.url,
    link: post.url,
    description: post.description,
    content: post.content,
    author: [{
      name: 'Jane Doe',
      email: '[e-mail]',
      link: 'https://example.com/janedoe'
    }, {
      name: 'Joe Smith',
      email: '[e-mail]',
      link: 'https://example.com/joesmith'
    }],
    contributor: [{
      name: 'Shawn Kemp',
      email: '[e-mail]',
      link: 'https://example.com/shawnkemp'
    }, {
      name: 'Reggie Miller',
      email: '[e-mail]',
      link: 'https://example.com/reggiemiller'
    }],
    date: post.date,
    image: post.image
  })
})

Insert categories using:

feed.addCategory('Technologie')

Insert contributors using:

feed.addContributor({
  name: 'Johan Cruyff',
  email: '[e-mail]',
  link: 'https://example.com/johancruyff'
})

Output a RSS 2.0 feed:

feed.rss2()

Output an Atom 1.0 feed:

feed.atom1()

Output a JSON Feed 1.0 feed:

feed.json1()

Yes, it's that simple :)!

More Information

• Feed for Node.js (English)
• Feed pour Node.js (French)
• Follow @jpmonette on Twitter for updates
• Read my personal blog Blogue de Jean-Philippe Monette to learn more about what I do!

License

Copyright (C) 2013, Jean-Philippe Monette [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.