Skip to content

Commit

Permalink
docs(README): Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kunalkapadia committed Jul 15, 2016
1 parent 26e5cfb commit 6dfb765
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Heavily inspired from [Egghead.io - How to Write an Open Source JavaScript Libra

- CORS support via [cors](https://github.com/troygoode/node-cors)
- Uses [http-status](https://www.npmjs.com/package/http-status) to set http status code. It is recommended to use `httpStatus.INTERNAL_SERVER_ERROR` instead of directly using `500` when setting status code.
- Has `.editorconfig` which helps developers define and maintain consistent coding styles between different editors and IDEs.

## Getting Started

Expand Down Expand Up @@ -92,7 +93,7 @@ git commit -m "chore(ghooks): Add pre-commit and commit-msg ghook"

```sh
# compile to ES5
1. npm build or gulp
1. npm run build or gulp

# upload dist/ to your server
2. scp -rp dist/ user@dest:/path
Expand All @@ -101,7 +102,7 @@ git commit -m "chore(ghooks): Add pre-commit and commit-msg ghook"
3. npm i --production

# Use any process manager to start your services
4. pm2 start index.js
4. pm2 start dist/index.js
```

In production you need to make sure your server is always up so you should ideally use any of the process manager recommended [here](http://expressjs.com/en/advanced/pm.html).
Expand Down

0 comments on commit 6dfb765

Please sign in to comment.