Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pkg support #59

Merged
merged 2 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
7 changes: 6 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
}