Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #202 from scottwarren/patch-1

Browse Source 
Fixing minor typos in the Read me
This commit is contained in:
Ivar Conradi Østhus 2017-01-13 09:09:32 +01:00 committed by GitHub
commit 0c377a6acc
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -12,7 +12,7 @@ fairly easy to develop client implementation for your favourite language.
The main motivation for doing feature toggling is to decouple the process for deploying code to production
and releasing new features. This helps reducing risk, and allow us to easily manage which features to enable
> Feature toggles decouple **deployment** of code from **release** of new features
> Feature toggles decouple **deployment** of code from **release** of new features
This repo contains the unleash-server, which contains the admin UI and a place to ask for the status of features.
In order to make use of unleash you will also need a client implementation.
@ -24,9 +24,9 @@ In order to make use of unleash you will also need a client implementation.
Online demo [version availble on heroku](https://unleash-new-ui.herokuapp.com/#/features).
## Activation strategies
It's fine to have a system for turning stuff on and off. But some times we want more granular controll,
It's fine to have a system for turning stuff on and off. But some times we want more granular control,
we want to decide who to the toggle should be enabled for. This is where activation strategies comes in to
the picture. Activation strategies takes arbitrary config and allows us to enable a toggle in various ways.
the picture. Activation strategies take arbitrary config and allows us to enable a toggle in various ways.
Common activation strategies includes:
- Active For users with a specified userId
@ -56,10 +56,10 @@ if(unleash.isEnabled("AwesomeFeature")) {
## Requirements
You will need a __PostreSQL__ 9.3+ database instance to be able to run Unleash.
You will need a __PostgreSQL__ 9.3+ database instance to be able to run Unleash.
When starting Unleash you must specify a database uri (can be set as environment variable DATABASE_URL)
which includes a username and password, that have rights to migrate the database.
When starting Unleash you must specify a database URI (can be set as environment variable DATABASE_URL)
which includes a username and password, which has the rights to migrate the database.
_Unleash_ will, at startup, check whether database migration is needed, and perform necessary migrations.
@ -70,7 +70,7 @@ _Unleash_ will, at startup, check whether database migration is needed, and perf
```bash
$ npm install unleash-server -g
$ unleash -d postgres://unleash_user:passord@localhost:5432/unleash -p 4242
$ unleash -d postgres://unleash_user:password@localhost:5432/unleash -p 4242
Unleash started on port:4242
```