Updated README

fireflysemantics · Mar 5, 2020 · 7c8b1bd · 7c8b1bd
1 parent 4aa23af
commit 7c8b1bd
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 5 deletions.
diff --git a/projects/validatorts/README.md b/projects/validatorts/README.md
@@ -1,10 +1,42 @@
-# ValidatorTS
+[![Build Status](https://travis-ci.org/fireflysemantics/validatorts.svg?branch=master)](https://travis-ci.org/fireflysemantics/validatorts)
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.3.
+# Install
 
-## Build
+```
+npm i -S @fireflysemantics/validatorts
+```
 
-Run `ng build validatorjs` to build the project. The build artifacts will be stored in the `dist/` directory.
+# Use
+
+```
+const isPortNumber:boolean = isPort('4200')
+console.log(isPortNumber)
+```
+
+# ValidatorTS Workspace    
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.4.
+
+
+## Build ValidatorTS
+
+Run `ng build validatorts`
+
+## Running unit tests
+
+Run the Jest Tests for ValidatorTS
+
+`npm t`
+
+## Browse Typedoc
+
+[Typedoc](https://fireflysemantics.github.io/validatorts/doc/)
+
+## Generate Typedoc 
+
+`npm run doc-validatorts
+
+Typedoc will be contained in the `doc` folder of the root directory.
 
 ## Publishing
 

diff --git a/projects/validatorts/package.json b/projects/validatorts/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@fireflysemantics/validatorts",
   "description": "String validation and sanitization",
-  "version": "12.2.13",
+  "version": "12.2.14",
   "homepage": "https://github.com/fireflysemantics/validatorts",
   "scripts": {
     "test": "jest",