From a5263b12f54ffbe435f4f61dae7044a88fb53815 Mon Sep 17 00:00:00 2001 From: James Bie Date: Tue, 10 Jul 2018 10:47:15 -0700 Subject: [PATCH] docs: change README.md to make the intro more concise change README.md intro to clarify and remove redundant text [skip ci] --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b23b64b7..1625b5ea 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ # nodemon -For use during development of a node.js based application. +nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected. -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 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* additional changes to your code or method of development. nodemon is a replacement wrapper for `node`, to use `nodemon` replace the word `node` on the command line when executing 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)