Include readme examples (#8)

* Export ValidationException

* Add Examples to README.md

Author: ZimmerA

README.md

@@ -1,10 +1,74 @@
 # cwl-ts-auto
+![Actions CI](https://github.com/common-workflow-lab/cwl-ts-auto/actions/workflows/workflow.yml/badge.svg)
+[![npm version](https://badge.fury.io/js/cwl-ts-auto.svg)](https://badge.fury.io/js/cwl-ts-auto)
+
 This project contains TypeScript objects and utilities auto-generated by https://github.com/common-workflow-language/schema_salad for parsing documents corresponding to the https://w3id.org/cwl/cwl schema
 
-## Installation
+## Installation & Usage
 To install the latest version of cwl-ts-auto execute:
 
 `npm install cwl-ts-auto`
 
+### Loading Documents
+Documents can be loaded by specyfying a file path or by string
+```TypeScript
+import * as cwltsauto from 'cwl-ts-auto'
+import fs from 'fs'
+import url from 'url'
+
+// Load document by file
+cwltsauto.loadDocument('./test.cwl')
+    .then((file) => {
+        if (file instanceof cwltsauto.CommandLineTool) {
+            console.log('This document is a CommandLineTool with baseCommand: ', file.baseCommand)
+        }
+    })
+    .catch((e) => {
+        if(e instanceof cwltsauto.ValidationException) {
+            console.log(e.toString())
+        } else {
+            console.log(e)
+        }
+    })
+
+// Load document by string
+let docAsString = fs.readFileSync('./test.cwl').toString()
+cwltsauto.loadDocumentByString(docAsString, url.pathToFileURL('/your/base/uri/').toString())
+    .then((file) => {
+        if (file instanceof cwltsauto.CommandLineTool) {
+            console.log('This document is a CommandLineTool with baseCommand: ', file.baseCommand)
+        }
+    })
+    .catch((e) => {
+        if(e instanceof cwltsauto.ValidationException) {
+            console.log(e.toString())
+        } else {
+            console.log(e)
+        }
+    })
+```
+
+### Creating, editing and saving Documents
+This example shows how to create a simple CommandLineTool with one input
+```TypeScript
+import * as cwltsauto from 'cwl-ts-auto'
+
+let exampleCommandLineTool =
+    new cwltsauto.CommandLineTool({
+        class_: cwltsauto.CommandLineTool_class.COMMANDLINETOOL,
+        inputs: [],
+        outputs: []
+    })
+exampleCommandLineTool.baseCommand = 'echo'
+
+let exampleInput =
+    new cwltsauto.CommandInputParameter({
+        type: cwltsauto.PrimitiveType.STRING
+    })
+exampleInput.default_ = 'Hello World!'
+exampleCommandLineTool.inputs.push(exampleInput)
+
+console.log(JSON.stringify(exampleCommandLineTool.save()))
+```
 ## Limitations
 cwl-ts-auto only supports the CWL v1.2 syntax. Other documents have to be upgraded using the [cwl-upgrader](https://pypi.org/project/cwl-upgrader/)

src/index.ts

@@ -1,6 +1,7 @@
 export {
   loadDocument,
   loadDocumentByString,
+  ValidationException,
   ToolTimeLimit_class,
   WorkReuse_class,
   NetworkAccessProperties,