@hmcts/cmc-validators - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "@hmcts/cmc-validators",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": "HMCTS",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

 # cmc-validators
 
-This is validator library, containing frontend validators used in CMC frontend applications.
+This is a validator library, containing frontend validators used in CMC frontend applications. 
+i.e [cmc-citizen-frontend](https://github.com/hmcts/cmc-citizen-frontend) and [cmc-legal-rep-frontend](https://github.com/hmcts/cmc-legal-rep-frontend)
 
-## Developing
+## Getting started
 
-### Code style
+### How to use it?
 
+#### Installation
+
+To add library to the project dependencies run:
+
+```bash
+$ yarn add @hmcts/cmc-validators
+```
+
+or
+
+```bash
+$ npm install @hmcts/cmc-validators
+```
+
+#### Dependencies
+
 Install dependencies by executing the following command:
@@ -14,12 +31,19 @@
  ```
- 
-We use [TSLint](https://palantir.github.io/tslint/) with [StandardJS](http://standardjs.com/index.html) rules alongside [sass-lint](https://github.com/sasstools/sass-lint)
 
-Running the linting:
-`yarn lint`
+#### Code style
 
-### Running the tests
+We use [TSLint](https://palantir.github.io/tslint/) with [StandardJS](http://standardjs.com/index.html) rules 
 
-Mocha is used for writing tests.
+Run the linting:
 
+```bash
+$ yarn lint
+```
+
+Linting will also run automatically prior to committing changes.
+
+#### Running the tests
+
+[Mocha](https://mochajs.org) is used for writing tests.
+
 Run them with:
@@ -31,8 +55,7 @@
 
-## Install
+For test coverage run:
 
-Run:
+```bash
+$ yarn test:coverage
 ```
-$ yarn add @hmcts/cmc-validators
-```
 
@@ -39,0 +62,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

127519

increased by3.49%

Number of package files

19

increased by26.67%

Lines of code

315

increased by52.17%

Number of lines in readme file

63

increased by57.5%

No dependency changes