From 054a3d2747f846af206ed965bfa66599deb52218 Mon Sep 17 00:00:00 2001 From: Soarez Date: Sat, 6 Oct 2012 12:09:58 +0100 Subject: [PATCH] Better instructions in README.md --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f0106e0..b56dfb4 100644 --- a/README.md +++ b/README.md @@ -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.