changelog_output - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

cli.js

@@ -18,3 +18,3 @@ #!/usr/bin/env node
 let slackPath = slack || ''
-const config = 'config.json'
+const config = 'co-config.json'
 let writeOutputFile = writeOutput || false
@@ -21,0 +21,0 @@ let version = ''

package.json

 {
   "name": "changelog_output",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -6,11 +6,20 @@ # Changelog Output
 
-## Run
+This checks for changes between the new version and last version.
+
+## Usage
 ```
 ./node_modules/.bin/cogenerate
+
+or add as a script to run inside of npm package.json
+
+"script": {
+	...,
+	"generate": "./node_modules/.bin/cogenerate"
+}
 ```
 
 ## Options
-There are 4 options you can provide to the generate either as command line args or as a config.json file.
+There are 4 options you can provide to the generate either as command line args or as a co-config.json file.
 
-> NOTE: Slack webhooks are secret URLS and should not allowed in the config file. Pass as an arg for safety.
+> NOTE: Slack webhooks are secret URLS and should not be allowed in the config file. Pass as an arg for safety.
 
@@ -21,3 +30,3 @@ Link is built off the assumption that you are using jira. How this works is it looks for the ticket number inside of
 ### Config
-In the root directory where you run this command add a `config.json` file.
+In the root directory where you run this command add a `co-config.json` file.
 
@@ -39,5 +48,2 @@ ```
 ```
-alias the bin command inside your package.json as a script
-assuming "generate: ./node_modules/.bin/cogenerate"
-
 npm run generate -- --writeOutput false --fileName CHANGELOG.md --link https://some/path/to/ --slack my/secret/ending/url
@@ -44,0 +50,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

7613

increased by1.2%

Number of lines in readme file

70

increased by9.38%

No dependency changes