diff --git a/README.md b/README.md index 23a85f6..2c711a6 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,17 @@ $ npm install ./readme-generator-for-helm Depending on how you installed NodeJS in your system, you may need to modify your `PATH` environment variable to be able to execute the tool. +## Single Binary + +Execute the following commands to create a single executable binary for the tool: + +```console +$ git clone https://github.com/bitnami-labs/readme-generator-for-helm +$ cd ./readme-generator-for-helm +$ npm install -g pkg +$ pkg . -o readme-generator-for-helm +``` + ## Test We use [Jest](https://jestjs.io) to implement the tests. In order to test your changes, execute the following command: diff --git a/package.json b/package.json index 911327a..0670de5 100644 --- a/package.json +++ b/package.json @@ -45,5 +45,10 @@ "bugs": { "url": "https://github.com/bitnami-labs/readme-generator-for-helm/issues" }, - "homepage": "https://github.com/bitnami-labs/readme-generator-for-helm#readme" + "homepage": "https://github.com/bitnami-labs/readme-generator-for-helm#readme", + "pkg": { + "assets": [ + "config.json" + ] + } }