From 82df431adfa0666245e71bebef49a384b033427e Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Sun, 12 Jun 2016 04:31:43 +0200 Subject: [PATCH] improve README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0854cc0..bca5743 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,14 @@ There is a docker image available that includes npmts to make CI a breeze: [hosttoday/ht-docker-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/) ### Install -First install npmts as dev dependency: +First install npmts globally, then install the npmts checker: ```sh -npm install npmts --save-dev +npm install npmts -g # installs npmts globally +npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency ``` -Then use it in package.json's script section to trigger a build: +Then add it to your package.json's script section to trigger a build: ```json "scripts": { @@ -42,8 +43,6 @@ Then use it in package.json's script section to trigger a build: 1. Instrumentalize created JavaScript files with istanbul 1. Run Tests 1. Create Coverage report -1. Upload Coverage reports to codecov.io (Tests must pass, codecov.io must be activated, by default only triggers on travis) -1. Upload JsDoc Documentation to gh-pages branch on GitHub. (Tests must pass, requires GitHub Token) #### npmts.json the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS. @@ -131,6 +130,12 @@ thanks to autogenerated source maps. > We will add more options over time. +## Tips and tricks: + +* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available. +* Use [npmpage](https://www.npmjs.com/package/npmtspage) to create a webpage from coverage reports and JsDocs for the module +* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds + ## About the authors: [![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)