/ README.md
README.md
 1  <div align="center">
 2  
 3  # asdf-erlang-ls [![Build](https://github.com/adas0x/asdf-erlang-ls/actions/workflows/build.yml/badge.svg)](https://github.com/adas0x/asdf-erlang-ls/actions/workflows/build.yml) [![Lint](https://github.com/adas0x/asdf-erlang-ls/actions/workflows/lint.yml/badge.svg)](https://github.com/adas0x/asdf-erlang-ls/actions/workflows/lint.yml)
 4  
 5  [erlang-ls](https://github.com/erlang-ls/erlang_ls) plugin for the [asdf version manager](https://asdf-vm.com).
 6  
 7  </div>
 8  
 9  # Contents
10  
11  - [Dependencies](#dependencies)
12  - [Install](#install)
13  - [Contributing](#contributing)
14  - [License](#license)
15  
16  # Dependencies
17  
18  **TODO: adapt this section**
19  
20  - `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
21  - `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.
22  
23  # Install
24  
25  Plugin:
26  
27  ```shell
28  asdf plugin add erlang-ls
29  # or
30  asdf plugin add erlang-ls https://github.com/adas0x/asdf-erlang-ls.git
31  ```
32  
33  erlang-ls:
34  
35  ```shell
36  # Show all installable versions
37  asdf list-all erlang-ls
38  
39  # Install specific version
40  asdf install erlang-ls latest
41  
42  # Set a version globally (on your ~/.tool-versions file)
43  asdf global erlang-ls latest
44  
45  # Now erlang-ls commands are available
46  erlang_ls -v
47  ```
48  
49  Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
50  install & manage versions.
51  
52  # Contributing
53  
54  Contributions of any kind welcome! See the [contributing guide](contributing.md).
55  
56  [Thanks goes to these contributors](https://github.com/adas0x/asdf-erlang-ls/graphs/contributors)!
57  
58  # License
59  
60  See [LICENSE](LICENSE) © [adas0x](https://github.com/adas0x/)