Skip to content

Commit

Permalink
Add example into README and edit pull request template
Browse files Browse the repository at this point in the history
Updates get command's flag from --output to --format

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
  • Loading branch information
alexellis committed May 26, 2023
1 parent 353aeb6 commit e5350f4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

## Documentation

- [ ] I have updated the list of tools in README.md if (required) with `./arkade get -o markdown`
- [ ] I have updated the list of tools in README.md if (required) with `./arkade get --format markdown`
- [ ] I have updated the list of apps in README.md if (required) with `./arkade install --help`

## Checklist:
Expand Down
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,20 @@ arkade get faas-cli \
```
> This is a time saver compared to searching for download pages every time you need a tool.
Files are stored at `$HOME/.arkade/bin/`

Want to download tools to a custom path such as into the GitHub Actions cached tool folder?

```bash
arkade get faas-cli kubectl \
--path $HOME/runner/_work/_tools

# Usage:
/runner/_work/_tools/faas-cli version

PATH=$PATH:$HOME/runner/_work/_tools
faas-cli version
```

Think of `arkade get TOOL` as a doing for CLIs, what `arkade install` does for helm.

Expand Down Expand Up @@ -814,4 +828,4 @@ There are 56 apps that you can install on your cluster.
There are 126 tools, use `arkade get NAME` to download one.


> Note to contributors, run `arkade get --output markdown` to generate this list
> Note to contributors, run `arkade get --format markdown` to generate this list

0 comments on commit e5350f4

Please sign in to comment.