Merge pull request #52 from bitnami-labs/fix-version-option

Fix version option and review documentation

.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}

README.md

@@ -72,11 +72,12 @@ npm run-script lint
 Usage: readme-generator [options]
 
 Options:
-  -r, --readme <path>   Path to the README.md file to insert the table
-  -v, --values <path>   Path to the values.yaml file
-  -c, --config <path>   Path to the config file
-  -s, --schema <path>   Path to a file where to store the OpenAPI Schema
-  -h, --help            display help for command
+  -v, --values <path>  Path to the values.yaml file
+  -r, --readme <path>  Path to the README.md file
+  -c, --config <path>  Path to the config file
+  -s, --schema <path>  Path for the OpenAPI Schema output file
+  --version            Show Readme Generator version
+  -h, --help           display help for command
 ```
 
 ## values.yaml Metadata
@@ -121,7 +122,7 @@ The configuration file has the following structure:
     "param": "@param",                           <-- Tag that indicates a parameter
     "section": "@section",                       <-- Tag that indicates a section
     "descriptionStart": "@descriptionStart",     <-- Tag that indicates the beginning of a section description
-    "descriptionEnd": "@descriptionEnd",         <-- Tag that indicates the end of a section description 
+    "descriptionEnd": "@descriptionEnd",         <-- Tag that indicates the end of a section description
     "skip": "@skip",                             <-- Tag that indicates the object must be skipped
     "extra": "@extra"                            <-- Tag to add a description for an intermediate object
   },

index.js

@@ -7,6 +7,7 @@
 /* eslint-disable import/no-dynamic-require */
 
 const fs = require('fs');
+const pjson = require('./package.json')
 
 const { createValuesObject, parseMetadataComments } = require('./lib/parser');
 const { checkKeys } = require('./lib/checker');
@@ -38,7 +39,7 @@ function runReadmeGenerator(options) {
   const versionFlag = options.version;
 
   if (versionFlag) {
-    console.log("Version:", JSON.parse(fs.readFileSync('./package.json')).version);
+    console.log("Version:", pjson.version);
   } else {
     if (!readmeFilePath && !schemaFilePath) {
       throw new Error('Nothing to do. Please provide the --readme or --schema options.');

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "readme-generator-for-helm",
-  "version": "2.4.1",
-  "description": "Autogenerate READMEs' tables for Bitnami Helm Charts",
+  "name": "@bitnami/readme-generator-for-helm",
+  "version": "2.4.2",
+  "description": "Autogenerate READMEs tables and OpenAPI schemas for Helm Charts",
   "main": "index.js",
   "scripts": {
     "test": "npx jest",
@@ -18,7 +18,7 @@
     "table",
     "autogenerate"
   ],
-  "license": "ISC",
+  "license": "Apache-2.0",
   "dependencies": {
     "commander": "^7.1.0",
     "dot-object": "^2.1.4",
@@ -31,5 +31,18 @@
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.22.1",
     "jest": "^26.6.3"
-  }
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "tests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bitnami-labs/readme-generator-for-helm.git"
+  },
+  "author": "",
+  "bugs": {
+    "url": "https://github.com/bitnami-labs/readme-generator-for-helm/issues"
+  },
+  "homepage": "https://github.com/bitnami-labs/readme-generator-for-helm#readme"
 }