From 563b105e963373f6a5ca1bf773b46c22d12ec4c9 Mon Sep 17 00:00:00 2001
From: John Heath <6026956+CaribouJohn@users.noreply.github.com>
Date: Thu, 13 May 2021 09:53:46 +0100
Subject: [PATCH] Create README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..06ae5a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# gps
+
+install either locally 
+
+```
+npm install gps-cli
+```
+
+or globally 
+
+```
+npm install -g gps-cli
+```
+
+to run local version use :
+
+```
+npx gps-cli create widget --name my-cool-widget
+```
+
+or a glocal version 
+
+```
+gps-cli create widget --name my-cool-widget
+```
+
+## NOTES
+
+The ```--name``` parameter is required, and should be entered as a dashed name because internally it uses this to produce Class and package names using the separator. 
+
+```
+  #--name my-cool-package produces the following names in the output
+  
+  MyCoolPackage
+  my-cool-package
+  my.cool.package
+  
+```
+
+