better README

README.md

@@ -15,17 +15,15 @@ It lets you to create a keyword based Twitter stream.
 
 ## Usage
 ```
-var TwStream=require('tweet_stream')
+var TwStream=require('tweet_stream'), 
+    through2=require('through2');
 
 var t=new TwStream({
     consumer_key:'xxx',
     consumer_secret:'yyy',
     access_token:'zzz',
     access_token_secret:'lll',
-    keywords: ['obama','election'],
-    callback: function(tweet){
-        console.log('tweet',tweet)
-    }
+    keywords: ['obama','election']
 }).pipe(through2.obj(function(tweet, encoding, done) {
     console.log('t', tweet.text);
     done();

npm-debug.log

@@ -0,0 +1,135 @@
+0 info it worked if it ends with ok
+1 verbose cli [ '/home/bitliner/v0.10.22/bin/node',
+1 verbose cli   '/home/bitliner/v0.10.22/bin/npm',
+1 verbose cli   'publish' ]
+2 info using npm@1.3.14
+3 info using node@v0.10.22
+4 verbose publish [ '.' ]
+5 verbose cache add [ '.', null ]
+6 verbose cache add name=undefined spec="." args=[".",null]
+7 verbose parsed url { protocol: null,
+7 verbose parsed url   slashes: null,
+7 verbose parsed url   auth: null,
+7 verbose parsed url   host: null,
+7 verbose parsed url   port: null,
+7 verbose parsed url   hostname: null,
+7 verbose parsed url   hash: null,
+7 verbose parsed url   search: null,
+7 verbose parsed url   query: null,
+7 verbose parsed url   pathname: '.',
+7 verbose parsed url   path: '.',
+7 verbose parsed url   href: '.' }
+8 silly lockFile 3a52ce78- .
+9 verbose lock . /home/bitliner/.npm/3a52ce78-.lock
+10 verbose tar pack [ '/home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz',
+10 verbose tar pack   '.' ]
+11 verbose tarball /home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+12 verbose folder .
+13 info prepublish tweet_stream@0.0.6
+14 silly lockFile 1f1177db-tar tar://.
+15 verbose lock tar://. /home/bitliner/.npm/1f1177db-tar.lock
+16 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+17 verbose lock tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz /home/bitliner/.npm/40b41f35-633-0-059633497847244143-tmp-tgz.lock
+18 silly lockFile 1f1177db-tar tar://.
+19 silly lockFile 1f1177db-tar tar://.
+20 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+21 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+22 verbose tar unpack /home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+23 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+24 verbose lock tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package /home/bitliner/.npm/6089ed4f-633-0-059633497847244143-package.lock
+25 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+26 verbose lock tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz /home/bitliner/.npm/40b41f35-633-0-059633497847244143-tmp-tgz.lock
+27 silly gunzTarPerm modes [ '755', '644' ]
+28 silly gunzTarPerm extractEntry package.json
+29 silly gunzTarPerm modified mode [ 'package.json', 436, 420 ]
+30 silly gunzTarPerm extractEntry README.md
+31 silly gunzTarPerm modified mode [ 'README.md', 436, 420 ]
+32 silly gunzTarPerm extractEntry index.js
+33 silly gunzTarPerm modified mode [ 'index.js', 436, 420 ]
+34 silly gunzTarPerm extractEntry example/TwitterKeywordStreamExample.js
+35 silly gunzTarPerm modified mode [ 'example/TwitterKeywordStreamExample.js', 436, 420 ]
+36 silly gunzTarPerm extractEntry lib/TweetStream.js
+37 silly gunzTarPerm modified mode [ 'lib/TweetStream.js', 436, 420 ]
+38 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+39 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+40 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+41 silly lockFile 40b41f35-633-0-059633497847244143-tmp-tgz tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/tmp.tgz
+42 verbose tar pack [ '/home/bitliner/.npm/tweet_stream/0.0.6/package.tgz',
+42 verbose tar pack   '/home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package' ]
+43 verbose tarball /home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+44 verbose folder /home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+45 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+46 verbose lock tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package /home/bitliner/.npm/6089ed4f-633-0-059633497847244143-package.lock
+47 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+48 verbose lock tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz /home/bitliner/.npm/bb8e6b38-m-tweet-stream-0-0-6-package-tgz.lock
+49 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+50 silly lockFile 6089ed4f-633-0-059633497847244143-package tar:///home/bitliner/tmp/npm-12231-K89-uUa5/1412766182633-0.059633497847244143/package
+51 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+52 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+53 silly lockFile afe86fb7-r-npm-tweet-stream-0-0-6-package /home/bitliner/.npm/tweet_stream/0.0.6/package
+54 verbose lock /home/bitliner/.npm/tweet_stream/0.0.6/package /home/bitliner/.npm/afe86fb7-r-npm-tweet-stream-0-0-6-package.lock
+55 silly lockFile afe86fb7-r-npm-tweet-stream-0-0-6-package /home/bitliner/.npm/tweet_stream/0.0.6/package
+56 silly lockFile afe86fb7-r-npm-tweet-stream-0-0-6-package /home/bitliner/.npm/tweet_stream/0.0.6/package
+57 verbose tar unpack /home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+58 silly lockFile 42a6dcc2-r-npm-tweet-stream-0-0-6-package tar:///home/bitliner/.npm/tweet_stream/0.0.6/package
+59 verbose lock tar:///home/bitliner/.npm/tweet_stream/0.0.6/package /home/bitliner/.npm/42a6dcc2-r-npm-tweet-stream-0-0-6-package.lock
+60 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+61 verbose lock tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz /home/bitliner/.npm/bb8e6b38-m-tweet-stream-0-0-6-package-tgz.lock
+62 silly gunzTarPerm modes [ '755', '644' ]
+63 silly gunzTarPerm extractEntry package.json
+64 silly gunzTarPerm extractEntry README.md
+65 silly gunzTarPerm extractEntry index.js
+66 silly gunzTarPerm extractEntry example/TwitterKeywordStreamExample.js
+67 silly gunzTarPerm extractEntry lib/TweetStream.js
+68 silly lockFile 42a6dcc2-r-npm-tweet-stream-0-0-6-package tar:///home/bitliner/.npm/tweet_stream/0.0.6/package
+69 silly lockFile 42a6dcc2-r-npm-tweet-stream-0-0-6-package tar:///home/bitliner/.npm/tweet_stream/0.0.6/package
+70 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+71 silly lockFile bb8e6b38-m-tweet-stream-0-0-6-package-tgz tar:///home/bitliner/.npm/tweet_stream/0.0.6/package.tgz
+72 verbose chmod /home/bitliner/.npm/tweet_stream/0.0.6/package.tgz 644
+73 verbose chown /home/bitliner/.npm/tweet_stream/0.0.6/package.tgz [ 1000, 1000 ]
+74 silly lockFile 3a52ce78- .
+75 silly lockFile 3a52ce78- .
+76 silly publish { name: 'tweet_stream',
+76 silly publish   version: '0.0.6',
+76 silly publish   description: 'Create your Twitter stream (based on keywords) in a declarative way, for more simplicity. It uses statuses/filter Twitter endpoint.',
+76 silly publish   main: 'index',
+76 silly publish   directories: { example: 'example' },
+76 silly publish   scripts: { test: 'echo "Error: no test specified" && exit 1' },
+76 silly publish   repository: { type: 'git', url: 'git@github.com:bitliner/TweetStream.git' },
+76 silly publish   keywords: [ 'twitter api', 'stream', 'twitter' ],
+76 silly publish   dependencies:
+76 silly publish    { underscore: '>=1.3.3',
+76 silly publish      twit: '~1.1.9',
+76 silly publish      'stream-wrapper': '~0.1.2' },
+76 silly publish   author: { name: 'bitliner' },
+76 silly publish   license: 'BSD',
+76 silly publish   readme: '# tweet_stream\n\nIt lets you to create a keyword based Twitter stream.\n\n**Pros** of using  *tweet_stream*:\n\n1. integration with nodejs streams: you can create a twitter stream and pipe it to an other nodejs stream that makes some computations on each tweet (check the example)\n\n2. it enriches each tweet with the specific keyword it was extracted by. In this way you can easily aggregate multiple streams, avoiding to reach the Twitter api limit for stream api\n\n## Installation\n\n`npm install tweet_stream`\n\n\n## Usage\n```\nvar TwStream=require(\'tweet_stream\')\n\nvar t=new TwStream({\n    consumer_key:\'xxx\',\n    consumer_secret:\'yyy\',\n    access_token:\'zzz\',\n    access_token_secret:\'lll\',\n    keywords: [\'obama\',\'election\'],\n    callback: function(tweet){\n        console.log(\'tweet\',tweet)\n    }\n}).pipe(through2.obj(function(tweet, encoding, done) {\n    console.log(\'t\', tweet.text);\n    done();\n}))\n```\n',
+76 silly publish   readmeFilename: 'README.md',
+76 silly publish   bugs: { url: 'https://github.com/bitliner/TweetStream/issues' },
+76 silly publish   homepage: 'https://github.com/bitliner/TweetStream',
+76 silly publish   _id: 'tweet_stream@0.0.6',
+76 silly publish   dist: { shasum: 'b20c94031611811a931b1e682a1edf9256254d32' },
+76 silly publish   _from: '.' }
+77 verbose url raw tweet_stream
+78 verbose url resolving [ 'https://registry.npmjs.org/', './tweet_stream' ]
+79 verbose url resolved https://registry.npmjs.org/tweet_stream
+80 info trying registry request attempt 1 at 13:03:02
+81 http PUT https://registry.npmjs.org/tweet_stream
+82 http 403 https://registry.npmjs.org/tweet_stream
+83 error publish Failed PUT response undefined
+84 error network getaddrinfo ENOTFOUND
+84 error network This is most likely not a problem with npm itself
+84 error network and is related to network connectivity.
+84 error network In most cases you are behind a proxy or have bad network settings.
+84 error network
+84 error network If you are behind a proxy, please make sure that the
+84 error network 'proxy' config is set properly.  See: 'npm help config'
+85 error System Linux 3.13.0-36-generic
+86 error command "/home/bitliner/v0.10.22/bin/node" "/home/bitliner/v0.10.22/bin/npm" "publish"
+87 error cwd /home/bitliner/projects/TweetStream
+88 error node -v v0.10.22
+89 error npm -v 1.3.14
+90 error syscall getaddrinfo
+91 error code ENOTFOUND
+92 error errno ENOTFOUND
+93 verbose exit [ 1, true ]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tweet_stream",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Create your Twitter stream (based on keywords) in a declarative way, for more simplicity. It uses statuses/filter Twitter endpoint.",
   "main": "index",
   "directories": {