Skip to content

Commit

Permalink
Better instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Soarez committed Oct 6, 2012
1 parent 514d521 commit 054a3d2
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Expand Up @@ -2,11 +2,28 @@
#### *A Rulio module that makes him...Clever*

====

## Install

git clone git://github.com/foliveira/clever-rulio.git
cd rulio
npm install
One day, I'll have the time to `npm publish` CleverRulio. Then, you'll be able to install CleverRulio by running this on your Rulio folder:

npm install cleverrulio

Until then, you can use it the same way you would if you were developing for it -- with [npm link](https://npmjs.org/doc/link.html). And maybe you can make a contribution!

#### Install with npm link

git clone git://github.com/foliveira/clever-rulio.git cleverrulio
cd cleverrulio
npm link

Then, in your Rulio folder:

npm link cleverrulio

This will create a symlink in node_modules to the repo you cloned, and Node.js will be able to load it like any installed npm module. And this way you can change cleverrulio and have Rulio know about those changes instantly.

## Tell Rulio to load CleverRulio

Add `cleverrulio` to your Rulio `config.json` modules list.

Expand Down

0 comments on commit 054a3d2

Please sign in to comment.