docs: remove "simply"

This commit is contained in:
Remy Sharp
2018-02-08 09:26:09 +00:00
parent 1e2492f120
commit f67e4bc71d
4 changed files with 8 additions and 8 deletions

View File

@@ -6,7 +6,7 @@ For use during development of a node.js based application.
nodemon will watch the files in the directory in which nodemon was started, and if any files change, nodemon will automatically restart your node application.
nodemon does **not** require *any* changes to your code or method of development. nodemon simply wraps your node application and keeps an eye on any files that have changed. Remember that nodemon is a replacement wrapper for `node`, think of it as replacing the word "node" on the command line when you run your script.
nodemon does **not** require *any* changes to your code or method of development. nodemon wraps your node application and keeps an eye on any files that have changed. Remember that nodemon is a replacement wrapper for `node`, think of it as replacing the word "node" on the command line when you run your script.
[![NPM version](https://badge.fury.io/js/nodemon.svg)](https://npmjs.org/package/nodemon)
[![Travis Status](https://travis-ci.org/remy/nodemon.svg?branch=master)](https://travis-ci.org/remy/nodemon) [![Backers on Open Collective](https://opencollective.com/nodemon/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/nodemon/sponsors/badge.svg)](#sponsors)
@@ -96,14 +96,14 @@ A config file can take any of the command line arguments as JSON key values, for
}
```
The above `nodemon.json` file might be my global config so that I have support for ruby files and processing files, and I can simply run `nodemon demo.pde` and nodemon will automatically know how to run the script even though out of the box support for processing scripts.
The above `nodemon.json` file might be my global config so that I have support for ruby files and processing files, and I can run `nodemon demo.pde` and nodemon will automatically know how to run the script even though out of the box support for processing scripts.
A further example of options can be seen in [sample-nodemon.md](https://github.com/remy/nodemon/blob/master/doc/sample-nodemon.md)
### package.json
If you want to keep all your package configurations in one place, nodemon supports using `package.json` for configuration.
Simply specify the config in the same format as you would for a config file but under `nodemonConfig` in the `package.json` file, for example, take the following `package.json`:
Specify the config in the same format as you would for a config file but under `nodemonConfig` in the `package.json` file, for example, take the following `package.json`:
```json
{
@@ -267,7 +267,7 @@ Note that the `process.kill` is *only* called once your shutdown jobs are comple
## Triggering events when nodemon state changes
If you want growl like notifications when nodemon restarts or to trigger an action when an event happens, then you can either `require` nodemon or simply add event actions to your `nodemon.json` file.
If you want growl like notifications when nodemon restarts or to trigger an action when an event happens, then you can either `require` nodemon or add event actions to your `nodemon.json` file.
For example, to trigger a notification on a Mac when nodemon restarts, `nodemon.json` looks like this:

View File

@@ -40,7 +40,7 @@ The `nodemon` object also has a few methods and properties. Some are exposed to
### Event handling
This is simply the event emitter bus that exists inside nodemon exposed at the top level module (ie. it's the `events` api):
This is the event emitter bus that exists inside nodemon exposed at the top level module (ie. it's the `events` api):
- `nodemon.on(event, fn)`
- `nodemon.addListener(event, fn)`

2
faq.md
View File

@@ -146,7 +146,7 @@ forever start --uid foo --killSignal=SIGTERM -c 'nodemon --exitcrash' server.js
To test this, you can kill the server.js process and forever will restart it. If you `touch server.js` nodemon will restart it.
To stop the process monitored by forever and nodemon, simply call the following, using the `uid` we assigned above (`foo`):
To stop the process monitored by forever and nodemon, call the following, using the `uid` we assigned above (`foo`):
```bash
forever stop foo

View File

@@ -109,7 +109,7 @@ function load(settings, options, config, callback) {
}
/**
* Loads the old style nodemonignore files which are simply a list of patterns
* Loads the old style nodemonignore files which is a list of patterns
* in a file to ignore
*
* @param {Object} options nodemon user options
@@ -210,7 +210,7 @@ function loadFile(options, config, dir, ready) {
function loadPackageJSON(config, ready) {
if (!ready) {
ready = () => {};
ready = () => { };
}
const dir = process.cwd();