README: add short usage info

This commit is contained in:
Miroslav Bajtoš 2014-06-05 09:14:13 +02:00
parent 0647c95e99
commit 33261d33f1
1 changed files with 14 additions and 2 deletions

View File

@ -2,7 +2,8 @@
LoopBack Boot is a convention-based bootstrapper for LoopBack applications.
**For full documentation, see the official StrongLoop documentation**:
**For full documentation, see the official StrongLoop documentation:**
* [Creating a LoopBack application](http://docs.strongloop.com/display/DOC/Creating+a+LoopBack+application)
## Installation
@ -11,5 +12,16 @@ LoopBack Boot is a convention-based bootstrapper for LoopBack applications.
## Usage
TBD
```js
var loopback = require('loopback');
var boot = require('loopback-boot');
var app = loopback();
boot(app, __dirname);
app.use(loopback.rest());
app.listen();
```
See [API docs](http://apidocs.strongloop.com/loopback-boot/) for
complete API reference.