Skip to content

Commit

Permalink
Fix contributing test command and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sarg3nt committed May 23, 2024
1 parent 80463af commit cd6baa2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 11 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# asdf-tealdeer [![Build](https:/sarg3nt/asdf-tealdeer/actions/workflows/build.yml/badge.svg)](https:/sarg3nt/asdf-tealdeer/actions/workflows/build.yml) [![Lint](https:/sarg3nt/asdf-tealdeer/actions/workflows/lint.yml/badge.svg)](https:/sarg3nt/asdf-tealdeer/actions/workflows/lint.yml)

[tealdeer](https:/sarg3nt/tealdeer) plugin for the [asdf version manager](https://asdf-vm.com).
[tealdeer](https:/dbrgn/tealdeer) plugin for the [asdf version manager](https://asdf-vm.com).

</div>

Expand All @@ -13,13 +13,6 @@
- [Contributing](#contributing)
- [License](#license)

# Dependencies

**TODO: adapt this section**

- `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.

# Install

Plugin:
Expand All @@ -43,7 +36,7 @@ asdf install tealdeer latest
asdf global tealdeer latest

# Now tealdeer commands are available
tealdeer
tldr
```

Check [asdf](https:/asdf-vm/asdf) readme for more instructions on how to
Expand Down
3 changes: 1 addition & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ Testing Locally:
```shell
asdf plugin test tealdeer https:/sarg3nt/asdf-tealdeer.git --asdf-tool-version 1.6.1

# TODO: adapt this
asdf plugin test tealdeer https:/sarg3nt/asdf-tealdeer.git "tealdeer"
asdf plugin test tealdeer https:/sarg3nt/asdf-tealdeer.git "tldr --version"
```

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

0 comments on commit cd6baa2

Please sign in to comment.