From d2fe53b3e60db27c4113e1679e2abfb9c9347fe3 Mon Sep 17 00:00:00 2001 From: Daniel Schildt Date: Wed, 5 Jul 2017 15:14:25 +0300 Subject: [PATCH] docs(README) improve document structure - Improve document structure to make it more readable. - Indent code snippets so that they get displayed properly. --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 06b0925..28085ed 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,18 @@ [ ![Codeship Status for koodiklinikka/koodiklinikka.fi-api](https://codeship.com/projects/5ba71cf0-7f0a-0132-b32d-661179cb74c9/status?branch=master)](https://codeship.com/projects/57155) ### Start developing -* Install node.js -``` -$ git clone git@github.com:koodiklinikka/koodiklinikka.fi-api.git -$ cd koodiklinikka.fi-api -$ npm install -``` - +* Install [Node.js](https://nodejs.org/en/) with your preferred installation method. +* Clone the repository and install dependencies. + ``` + $ git clone git@github.com:koodiklinikka/koodiklinikka.fi-api.git + $ cd koodiklinikka.fi-api + $ npm install + ``` * Create `config.json` file. See [config.template.json](https://github.com/koodiklinikka/koodiklinikka.fi-api/blob/master/config.template.json) for possible options. The config file consists of environment specific blocks. Environment variable `NODE_ENV` determines which block is used. If the environment variable is not present, the `development` block will be selected. `all` block is always used and the block selected is merged into it so that it overwrites the values defined in it. -* ``` -$ npm start -``` \ No newline at end of file +* Start the development environment. + ``` + $ npm start + ```