From 7352a4c716e5c95495bffc11dfdbcf27eee7e664 Mon Sep 17 00:00:00 2001 From: Remy Sharp Date: Fri, 31 Mar 2017 10:02:39 +0100 Subject: [PATCH] docs: add design principle --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 551dc65e..4ea5d96a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.