Skip to content

Commit

Permalink
docs: add design principle
Browse files Browse the repository at this point in the history
  • Loading branch information
remy committed Mar 31, 2017
1 parent 8c1fd44 commit 7352a4c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ And nodemon will be installed globally to your system path.
It is also possible to install locally:

npm install --save-dev nodemon

With a local installation, nodemon will not be available in your system path. Instead, the local installation of nodemon can be run by calling it from within an npm script (such as `npm start`). Additionally, the `npm bin` command can be used to obtain the path to the project's local `.bin` directory.

# Usage
Expand Down Expand Up @@ -270,6 +270,17 @@ Well...I've been asked this many times before. I like that I've been asked this

The answer is simple, but possibly frustrating. I'm not saying (how I pronounce it). It's up to you to call it as you like. All answers are correct :)

## Design principles

- Less flags is better
- Works across all platforms
- Less features
- Let individuals build on top of nodemon
- Offer all CLI functionality as an API
- Contributions must have and pass tests

Nodemon is not perfect, and CLI arguments has sprawled beyond where I'm completely happy, but perhaps it can be pulled back a little.

## FAQ

See the [FAQ](https://github.com/remy/nodemon/blob/master/faq.md) and please add your own questions if you think they would help others.
Expand Down

0 comments on commit 7352a4c

Please sign in to comment.