Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Seva Rybakov committed Apr 4, 2013
1 parent fd50a9c commit b77664d
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
@@ -1,10 +1,16 @@
# github-zen: A tiny utility for reading github zen
A tiny piece of javascript for watching zen streaming from GitHub API

## Installation

- Install node.js;
- Clone the repo;
- ```$ npm install```;
- ```$ ./zen.js```;
- Watch it.

### Tips and tricks
Default API limit is 60 requests per hour. You can enlarge it by passing your **GitHub** username as a first parameter.

You can also redirect output to a file so that you can read it later:
```
$ ./zen.js > zen.txt
```

0 comments on commit b77664d

Please sign in to comment.