jswank/binst
1
0
Fork 0
Code Pull Requests Releases Activity

minor update to README

Browse Source
This commit is contained in:
Jason Swank
2026-01-21 18:58:59 -05:00
parent 36348c0701
commit 916f475bc3
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -42,15 +42,21 @@ $ task install-trufflehog
### Creating New Installation Scripts ### Creating New Installation Scripts
The default task creates a new installation script for a binary from its GitHub The default task uses binstaller to creates a new installation script for a binary from
repository. This is often the only step needed to add a new installation script its GitHub repository. This is often the only step needed to add a new installation
to the collection. script to the collection.
To install binstaller, run:
```bash
$ scripts/binstaller-install.sh
```
To create a new installation script:
```bash ```bash
# create a new installation script by providing the GitHub repository as an argument: # create a new installation script by providing the GitHub repository as an argument:
$ task REPO=owner/repo-name $ task REPO=owner/repo-name
# summarize the default task # detailes summary
$ task --summary $ task --summary
task: default task: default
@@ -59,7 +65,8 @@ embedding checksums, and generating the installation script. The latest release,
determined by the latest-release task, will be used unless a specific version is determined by the latest-release task, will be used unless a specific version is
provided. provided.
Invoke this task like: task default REPO=trufflesecurity/trufflehog Invoke this task like:
task default REPO=trufflesecurity/trufflehog
vars: vars:
CONFIG_DIR: "./config" CONFIG_DIR: "./config"