Update README.md

README.md

@@ -0,0 +1,65 @@
+[![Coverage Status](https://coveralls.io/repos/github/codefresh-io/cf-errors/badge.svg?branch=develop)](https://coveralls.io/github/codefresh-io/cf-errors?branch=develop)
+
+# Codefresh erroring library
+This library is a wrapper of Verror library that adds additional beheaviour dedicated for our use.
+
+## Basic Usage - creating an error
+```javascript
+var CFError    = require('cf-errors');
+var ErrorTypes = CFError.errorTypes;
+
+var error = new CFError(
+  {
+    type: ErrorType.Error,
+    message: `error message`
+  }
+);
+```
+
+## Advanced Usage - extending an already existing error
+```javascript
+var extendedError = new CFError(
+  {
+    type: ErrorType.Error,
+    message: `extended error message`,
+    cause: error
+  }
+);
+```
+
+### Inheriting the previous error type
+In order to be able to extend the previous error with more data without affecting the type of the error is possible using the Inherited error type
+```javascript
+var extendedError = new CFError(
+  {
+    type: ErrorType.Inherit,
+    message: `extended error message`,
+    cause: error
+  }
+);
+```
+
+### signifying an error as a recognized error
+Sometimes it is important to be able to differentiate between an error that is recognized and between an un-recognized error.
+For example in case your api receives a request that has a missing parameter you would like to create an error but not report it back to your monitoring systems like new-relic.
+Then in your error middleware you can check if the error has been recognized and act accordingly and not report this error to your monitoring systems.
+```javascript
+var extendedError = new CFError(
+  {
+    type: ErrorType.Inherit,
+    message: `extended error message`,
+    cause: error,
+    recognized: true
+  }
+);
+```
+Then you can check if the error is recognized:
+```javascript
+if (error.isRecognized()){
+  //Your code
+}
+```
+The default return value of isRecognized function will be false.
+Signifying an error as a recognized error will affect the whole chain of errors and will be inherited.
+This also means that you can signify a higher error explicitly with the value false which will then make the isRecognized function return false.
+