diff --git a/README.md b/README.md index 87a880f..9b8f3fe 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,59 @@ to put comments in your code and then have them annotated across your whole proj ### Installation: - - npm install notes -g +```sh +$ npm install notes -g +``` ### Usage: - $ notes # will search for notes in cwd - $ notes lib/ test/ # will search only in lib and test +```sh +$ notes # will search for notes in cwd +$ notes lib/ test/ # will search only in lib and test +``` ### What It Does: For example, if a file contained these lines somewhere in it: - code... - # NOTE: This line should get annoated by Notes. - # OPTIMIZE Make things faster! - - more code... - # TODO: Annotate your tasks. - - yet more code... - # FIXME: Keep up with things to fix. +```text +code... +# NOTE: This line should get annoated by Notes. +# OPTIMIZE Make things faster! + +more code... +# TODO: Annotate your tasks. + +yet more code... +# FIXME: Keep up with things to fix. +``` Those comments would be annotated as: - * /path/to/my/file - Line 8: ✐ NOTE This line should get annoated by Notes. - Line 9: ↘ OPTIMIZE Make things faster! - Line 10: ✓ TODO Annotate your tasks. - Line 11: ☂ FIXME Keep up with things to fix. +```text +* /path/to/my/file +Line 8: ✐ NOTE This line should get annoated by Notes. +Line 9: ↘ OPTIMIZE Make things faster! +Line 10: ✓ TODO Annotate your tasks. +Line 11: ☂ FIXME Keep up with things to fix. +``` + +### Development: + +#### Build Project + +```sh +$ npm install # install all dependencies + +$ npm run -s build # build the project +# OR +$ npm i -g nodemon # install nodemon globally +$ npm run -s build:watch # watch src/ dir for changes +``` + +#### Test the Project + +```sh +$ npm link # make globally available +$ notes # use the `notes` app +```