Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
benberryallwood committed Jan 3, 2025
1 parent 78bac17 commit 38b4d7e
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,29 @@

# mise-spark [![Build](https://github.com/benberryallwood/mise-spark/actions/workflows/build.yml/badge.svg)](https://github.com/benberryallwood/mise-spark/actions/workflows/build.yml) [![Lint](https://github.com/benberryallwood/mise-spark/actions/workflows/lint.yml/badge.svg)](https://github.com/benberryallwood/mise-spark/actions/workflows/lint.yml)

[spark](https://spark.apache.org/documentation.html) plugin for the [asdf version manager](https://asdf-vm.com).
[Apache Spark](https://spark.apache.org/documentation.html) plugin for the [asdf version manager](https://asdf-vm.com).

</div>

# Contents
## Contents

- [Dependencies](#dependencies)
- [Install](#install)
- [Contributing](#contributing)
- [License](#license)

# Dependencies
## 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
## Install

Plugin:

```shell
asdf plugin add spark
# or
asdf plugin add spark https://github.com/benberryallwood/mise-spark.git
```

Expand All @@ -49,12 +47,12 @@ spark --help
Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
install & manage versions.

# Contributing
## Contributing

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

[Thanks goes to these contributors](https://github.com/benberryallwood/mise-spark/graphs/contributors)!

# License
## License

See [LICENSE](LICENSE) © [Ben Berry-Allwood](https://github.com/benberryallwood/)

0 comments on commit 38b4d7e

Please sign in to comment.