licensed - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

package.json

 {
   "name": "licensed",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "licensed is a command line interface to help you choose and add licenses to your projects",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

 # licensed
 
-[![Number of downloads](https://img.shields.io/npm/dw/licensed.svg?style=flat)](https://www.npmjs.com/package/licensed)
+[![Number of downloads](https://img.shields.io/npm/dt/licensed.svg?style=flat-square)](https://www.npmjs.com/package/licensed)
 [![Licence](https://img.shields.io/npm/l/licensed.svg?maxAge=2592000&style=flat)](LICENSE)
@@ -18,7 +18,11 @@ [![Number of dependencies](https://img.shields.io/david/plibither8/licensed.svg?maxAge=2592000&style=flat)](https://www.npmjs.com/package/licensed?activeTab=dependencies)
 
-* `$ npx licensed` 
+```sh
+$ npx licensed
+``` 
 
 If you've got an older version of node (npm version < 5.2) that doesn't yet have [`npx`](https://www.npmjs.com/package/npx), here's a more traditional setup:
 
-* `$ npm i -g licensed`
+```sh
+$ npm i -g licensed
+```
 
@@ -29,14 +33,43 @@ ## Usage
 
-* `$ licensed`
+```sh
+Usage:
+    $ licensed                  # Brings up an option to start a questionnaire or choose from a list of available licenses
+    $ licensed <license-name>   # Brings prompt to enter your name
+    $ licensed <license-name> <your-full-name>
+    $ licensed --help
+    $ licensed --version
 
-This will bring up an option to either **initiate a questionnaire** that will aid you in choosing and appropriate license for your project, or simply choose a license from a list of available licenses.
+Options:
+    --help      Show this screen
+    --version   Show version
 
-You can also use the CLI like so, by entering the license name and then your name (in single/double quotes):
+Examples:
+    $ licensed mit "Mihir Chaturvedi"
+    $ licensed mit
+```
 
-* `$ licensed mit "Dwight Schrute"`
+## Development
 
-which will create a `LICENSE` file with the MIT License under the name Dwight Schrute.
+Run:
 
-<!-- If hell breaks loose, use the `--help` flag to help you out! -->
+```sh
+$ git clone https://github.com/plibither8/licensed.git
+$ cd licensed
+$ npm link
+```
 
+This will setup a symbolic link to the CLI. Any changes in source files will now be reflected when running the `licensed` command.
+
+To lint your code, run
+
+```sh
+$ npm run lint
+```
+
+...and to build your files to `/lib` directory, run
+
+```sh
+$ npm run build
+```
+
 ## Available licenses to choose from (currently):
@@ -43,0 +76,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

257358

increased by47.67%

Number of lines in readme file

90

increased by57.89%

No dependency changes