From d06c56aec41b6aae45233b60325ac4172103f1cf Mon Sep 17 00:00:00 2001 From: Karl-Philipp Wulfert Date: Tue, 4 Dec 2018 16:28:30 +0100 Subject: [PATCH] docs: add documentation for added script --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 27cd90e9..95284dc2 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,11 @@ A collection of configuration base files for StApps projects. +Install it as a dev dependency in your project and it will automatically add a script in your `package.json` to execute it. + ```shell npm install --save-dev @openstapps/configuration +npm run check-configuration ``` You can also install it globally and use it as a cli. @@ -37,3 +40,5 @@ The following files are automatically copied to your project's root directory if ## Adjusted files Your project's `package.json` will be examined to determine whether or not you have `nyc` installed in your `devDependencies`. If it is installed the recommended configuration for `nyc` will be added to/updated in your `package.json`. + +A script called `check-configuration` will be added to your `package.json` to execute the configuration script manually again.