Comparing version 0.1.0 to 0.1.1
@@ -22,4 +22,3 @@ { | ||
"description": "rss2 is a RSS, Atom and JSON rss2 generator for Node.js based on `feed`, but removes types and adds required image <enclosure> attributes for RSS2 readers", | ||
"devDependencies": { | ||
}, | ||
"devDependencies": {}, | ||
"engines": { | ||
@@ -45,5 +44,4 @@ "node": ">=8.0" | ||
}, | ||
"scripts": { | ||
}, | ||
"version": "0.1.0" | ||
"scripts": {}, | ||
"version": "0.1.1" | ||
} |
@@ -1,17 +0,9 @@ | ||
<p align="center"> | ||
<img src="https://user-images.githubusercontent.com/1114325/60746552-2c059a00-9f77-11e9-9632-e21dea9dd06b.png" alt="Feed for Node.js" width="326"> | ||
<br> | ||
<a href="https://travis-ci.org/jpmonette/feed"><img src="https://travis-ci.org/jpmonette/feed.svg?branch=master" alt="Build Status"></a> <a href='https://coveralls.io/github/jpmonette/feed?branch=master'><img src='https://coveralls.io/repos/github/jpmonette/feed/badge.svg?branch=master' alt='Coverage Status' /></a> <a href="https://badge.fury.io/js/feed"><img src="https://badge.fury.io/js/feed.svg" alt="npm version" height="18"></a> <a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a> | ||
</p> | ||
<p align="center"><code>jpmonette/feed</code> - <strong>RSS 2.0, JSON Feed 1.0, and Atom 1.0</strong> generator for <strong>Node.js</strong><br> | ||
Making content syndication simple and intuitive!</p> | ||
# RSS2 | ||
--- | ||
### Based on jpmonette/feed ([`feed`](https://www.npmjs.com/package/feed) on NPM) | ||
**👩🏻💻 Developer Ready**: Quickly generate syndication feeds for your Website. | ||
Just needed `<enclosure>` to have required attributes to show up properly in a specific RSS reader. If you don't need that, you're far better off going to [`feed`](https://www.npmjs.com/package/feed) | ||
**💪🏼 Strongly Typed**: Developed using TypeScript / type-safe. | ||
--- | ||
**🔒 Tested**: Tests & snapshot for each syndication format to avoid regressions. | ||
# Getting Started | ||
@@ -22,3 +14,3 @@ | ||
```bash | ||
$ yarn add feed | ||
$ npm i rss2 | ||
``` | ||
@@ -29,3 +21,3 @@ | ||
```js | ||
import { Feed } from "feed"; | ||
const { Feed } = require('rss2'); | ||
@@ -107,18 +99,1 @@ const feed = new Feed({ | ||
``` | ||
## Migrating from `< 3.0.0` | ||
If you are migrating from a version older than `3.0.0`, be sure to update your import as we migrated to ES6 named imports. | ||
If your environment supports the ES6 module syntax, you can `import` as described above: | ||
```js | ||
const { Feed } = require('rss2'); | ||
``` | ||
Otherwise, you can stick with `require()`: | ||
```diff | ||
- const Feed = require('feed'); | ||
+ const Feed = require('feed').Feed; | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
14696
97