Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
booniepepper committed Oct 29, 2023
1 parent 3491bf7 commit 4dbf6e7
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# asdf-dt [![Build](https://github.com/booniepepper/asdf-dt/actions/workflows/build.yml/badge.svg)](https://github.com/booniepepper/asdf-dt/actions/workflows/build.yml) [![Lint](https://github.com/booniepepper/asdf-dt/actions/workflows/lint.yml/badge.svg)](https://github.com/booniepepper/asdf-dt/actions/workflows/lint.yml)

[dt](https://dt.plumbing) plugin for the [asdf version manager](https://asdf-vm.com).
[dt](https://dt.plumbing) plugin for [rtx](https://github.com/jdx/rtx) and [asdf](https://asdf-vm.com).

</div>

Expand All @@ -15,22 +15,25 @@

# 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

Plugin:
Install this plugin:

```shell
asdf plugin add dt
rtx plugin add https://github.com/so-dang-cool/asdf-dt.git
# or
asdf plugin add dt https://github.com/booniepepper/asdf-dt.git
```

dt:
Use dt (rtx):

```shell
rtx use dt@latest
```

Install dt (asdf):

```shell
# Show all installable versions
Expand All @@ -46,14 +49,14 @@ asdf global dt latest
dt --version
```

Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
install & manage versions.
Check [rtx](https://github.com/jdx/rtx) or [asdf](https://github.com/asdf-vm/asdf)
readme for more instructions on how to install & manage versions.

# Contributing

Contributions of any kind welcome! See the [contributing guide](contributing.md).

[Thanks goes to these contributors](https://github.com/booniepepper/asdf-dt/graphs/contributors)!
[Thanks goes to these contributors](https://github.com/so-dang-cool/asdf-dt/graphs/contributors)!

# License

Expand Down

0 comments on commit 4dbf6e7

Please sign in to comment.