Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-21 09:03:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add documentation for added script

Browse Source
This commit is contained in:
Karl-Philipp Wulfert
2018-12-04 16:28:30 +01:00
parent bb0f1637c7
commit d06c56aec4
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -7,8 +7,11 @@
A collection of configuration base files for StApps projects. 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 ```shell
npm install --save-dev @openstapps/configuration npm install --save-dev @openstapps/configuration
npm run check-configuration
``` ```
You can also install it globally and use it as a cli. 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 ## 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`. 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.