Add CLI

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

README.md

@@ -6,24 +6,29 @@ The pickup [Node.js](http://nodejs.org/) module is a [Transform](http://nodejs.o
 
 ## Usage
 
-Install [jsontool](https://github.com/trentm/json) to format JSON in the command-line:
+To transform from stdin to stdout:
+
+    var pickup = require('pickup')
+    , transformer = pickup()
+    , Readable = require('stream').Readable
+    , reader = new Readable().wrap(process.openStdin())
+    , writer = process.stdout
+
+    reader.pipe(transformer).pipe(writer)
+
+If you haven't already, I suggest you intall [jsontool](https://github.com/trentm/json), a `json` command for working with JSON on the command-line:
 
     npm install -g jsontool
-
-Clone pickup to run examples:
-
-    git clone git://github.com/michaelnisi/pickup.git
-    cd pickup
-
-Pipe stdin to stdout:
-
-    cat test/itunes.xml | node example/stdin.js | json
 
+Now you can transform RSS to JSON on the command-line like so:
+
+    curl -sS http://feeds.feedburner.com/the_talk_show | pickup | json
+
 ## Installation
 
 Install with [npm](https://npmjs.org):
 
-    npm install pickup
+    npm install -g pickup
 
 ## License
 

bin/cli.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+;(function () {
+  var pickup = require('../')
+    , transformer = pickup()
+    , Readable = require('stream').Readable
+    , reader = new Readable().wrap(process.openStdin())
+    , writer = process.stdout
+
+  reader.pipe(transformer).pipe(writer)
+})()

index.js

@@ -1,9 +1,9 @@
 
-// pickup - transform RSS or Atom feed to JSON
+// pickup - transform RSS or Atom XML to JSON
 
 var sax = require('sax')
   , Transform = require('stream').Transform
-  , maps = require('./lib/maps')()
+  , mappings = require('./lib/mappings')()
   , CHANNEL = 'channel'
   , ITEM = 'item'
   , FEED = 'feed'
@@ -56,7 +56,7 @@ module.exports = function () {
     name = node.name
 
     if (isElement(name)) {
-      map = maps[name]
+      map = mappings[name]
     }
 
     switch (name) {
@@ -115,7 +115,6 @@ module.exports = function () {
     name = null
   }
 
-
   return stream
 }
 

lib/maps.js → lib/mappings.js

@@ -1,5 +1,5 @@
 
-// maps - map elements
+// mappings - map elements to property names
 
 module.exports = function () {
   var channel = {
@@ -60,12 +60,12 @@ module.exports = function () {
   , 'email':'email'
   }
 
-  var maps = {
+  var mappings = {
     channel:channel
   , item:item
   , feed:feed
   , entry:entry
   }
 
-  return maps
+  return mappings
 }

package.json

@@ -1,15 +1,19 @@
 {
   "name": "pickup",
-  "version": "0.1.2",
-  "description": "transform RSS or ATOM XMLto JSON",
+  "version": "0.1.3",
+  "description": "transform RSS or ATOM XML to JSON",
   "main": "index.js",
   "directories": {
+    "lib": "lib",
     "example": "example",
     "test": "test"
   },
   "scripts": {
     "test": "tap test/*.js"
   },
+  "bin": {
+    "pickup": "bin/cli.js"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/michaelnisi/pickup.git"