diff --git a/README.md b/README.md index 815c9ee..6e14114 100644 --- a/README.md +++ b/README.md @@ -21,36 +21,44 @@ The longer term goal of this tool is that it is intended to be a common entry p The tool is intended for the creation of Angular and Node based assets (at the time of writing). Therefore you will need as a minimum to have a version of [node](https://nodejs.org/en/) installed. -For Widget creation it will also be assumed you have angular installed +If your organisation does not allow global installation you should install locally and use [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner) to run the commands +``` + npx gps-cli ... +``` -## Installation +When you install this package it will also install the @c8y/cli package locally and it will use this to create the base dashboard application for incrementally developing your widget. -install either locally +You can use the c8ycli in the following way within your project directory, see [documentation](https://www.npmjs.com/package/@c8y/cli) for arguments and how to use it. ``` -npm install gps-cli + npx c8ycli [options] [command] ``` -or globally -``` -npm install -g gps-cli -``` -to run local version use : +## Installation + +There are 2 ways to install this tool. + +* install locally when you are restricted in what you can install, or don't want to install globally + * *Note that the executable will only be available within the project directory* ``` +npm install gps-cli npx gps-cli create widget --name my-cool-widget + ``` -or a glocal version +* Install globally (like any application) to make the command line tool available on the path (use in any directory) ``` +npm install -g gps-cli gps-cli create widget --name my-cool-widget + ``` -## NOTES +## Usage 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. diff --git a/package.json b/package.json index 9fc7cd0..bc15326 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "widget", "cli" ], - "author": "cariboujohn (https://github.com/CaribouJohn/gps)", + "author": "cariboujohn (https://github.com/SoftwareAG/cumulocity-global-presales-cli)", "license": "ISC", "dependencies": { "@c8y/cli": "^1007.0.36", @@ -27,7 +27,7 @@ "@types/node": "^14.14.37" }, "bugs": { - "url": "https://github.com/CaribouJohn/gps/issues" + "url": "https://github.com/SoftwareAG/cumulocity-global-presales-cli/issues" }, - "homepage": "https://github.com/CaribouJohn/gps" -} + "homepage": "https://github.com/SoftwareAG/cumulocity-global-presales-cli" +} \ No newline at end of file