diff --git a/README.md b/README.md index b15ab6e..35c431a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # asdf-tealdeer [![Build](https://github.com/sarg3nt/asdf-tealdeer/actions/workflows/build.yml/badge.svg)](https://github.com/sarg3nt/asdf-tealdeer/actions/workflows/build.yml) [![Lint](https://github.com/sarg3nt/asdf-tealdeer/actions/workflows/lint.yml/badge.svg)](https://github.com/sarg3nt/asdf-tealdeer/actions/workflows/lint.yml) -[tealdeer](https://github.com/sarg3nt/tealdeer) plugin for the [asdf version manager](https://asdf-vm.com). +[tealdeer](https://github.com/dbrgn/tealdeer) plugin for the [asdf version manager](https://asdf-vm.com). @@ -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: @@ -43,7 +36,7 @@ asdf install tealdeer latest asdf global tealdeer latest # Now tealdeer commands are available -tealdeer +tldr ``` Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to diff --git a/contributing.md b/contributing.md index 1e2eb62..f168898 100644 --- a/contributing.md +++ b/contributing.md @@ -5,8 +5,7 @@ Testing Locally: ```shell asdf plugin test tealdeer https://github.com/sarg3nt/asdf-tealdeer.git --asdf-tool-version 1.6.1 -# TODO: adapt this -asdf plugin test tealdeer https://github.com/sarg3nt/asdf-tealdeer.git "tealdeer" +asdf plugin test tealdeer https://github.com/sarg3nt/asdf-tealdeer.git "tldr --version" ``` Tests are automatically run in GitHub Actions on push and PR.