1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

Added a small getting started document #119

This commit is contained in:
Ivar 2016-09-29 23:08:36 +02:00 committed by Ivar Conradi Østhus
parent 124799b200
commit f5dc1e8abd

23
docs/getting-started.md Normal file
View File

@ -0,0 +1,23 @@
(unleash-server is currently not released yet with these capabilites, but when it is this is how to use unleash)
### The simplest way to get started:
```bash
$ npm install unleash-server -g
$ unleash -d postgres://unleash_user:passord@localhost:5432/unleash -p 4242
Unleash started on port:4242
```
### Or programmatically:
```js
const unleash = require('unleash-server');
unleash.start({
databaseUri: 'postgres://unleash_user:passord@localhost:5432/unleash'
port: 4242
}).then(unleash => {
console.log(`Unleash started on port:${unleash.app.get('port')}`);
});
```