From 17dd310514dd507f584c698731d8cce2990983f0 Mon Sep 17 00:00:00 2001 From: Ivar Date: Thu, 29 Sep 2016 23:08:36 +0200 Subject: [PATCH] Added a small getting started document #119 --- docs/getting-started.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/getting-started.md diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000000..eabe5d0115 --- /dev/null +++ b/docs/getting-started.md @@ -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')}`); +}); +```