Skip to content

Commit

Permalink
fix documents
Browse files Browse the repository at this point in the history
  • Loading branch information
ucpr committed Jun 7, 2023
1 parent c0b9896 commit e542fb5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@

# Dependencies

**TODO: adapt this section**

- `bash`, `curl`, `tar`: generic POSIX utilities.
- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.

# Install

Expand All @@ -42,8 +39,8 @@ asdf install circleci-cli latest
# Set a version globally (on your ~/.tool-versions file)
asdf global circleci-cli latest

# Now circleci-cli commands are available
circleci-cli --help
# Now circleci commands are available
circleci --help
```

Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Testing Locally:
asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]

# TODO: adapt this
asdf plugin test circleci-cli https://github.com/ucpr/asdf-circleci-cli.git "circleci-cli --help"
asdf plugin test circleci-cli https://github.com/ucpr/asdf-circleci-cli.git "circleci --help"
```

Tests are automatically run in GitHub Actions on push and PR.

0 comments on commit e542fb5

Please sign in to comment.