Skip to content

Commit

Permalink
update to README explaining local module require use.
Browse files Browse the repository at this point in the history
  • Loading branch information
bustardcelly committed Mar 25, 2014
1 parent e804e3c commit fb0a852
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,34 @@ Tests
$ npm run test
```

Caddis as Local Module
---
It is also possible to use `caddis` as a locally required module (as oppose to installing globally with `-g`):

### Installation
```
$ npm install caddis
```

### Usage
```
var caddis = require('caddis');
caddis.start(3002, function() {
// caddis started on http://localhost:3002
});
...
caddis.stop(function() {
// caddis stopped.
});
```

### Tests
```
$ npm run test-module
```

License
---
Copyright (c) 2014 Todd Anderson
Expand Down

0 comments on commit fb0a852

Please sign in to comment.