add readme

Ubuntu · Ubuntu · commit 41999251031e · 2015-11-13T02:12:54.000Z
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# rss-parser
+
+## Installation
+
+```bash
+npm install --save rss-parser
+```
+
+## Usage
+
+```js
+var parser = require('rss-parser');
+
+parser.parseURL('https://reddit.com/.rss', function(err, parsed) {
+  console.log(parsed)
+})
+```
+
+rss-parser also exposes `parseString` and `parseFile` functions.
+
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rss-parser",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "scripts": {
     "test": "mocha"
