Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
- reorganized how links are written
- add badge for CircleCI lint workflow
- removed contributing section
  • Loading branch information
rynkowsg committed Apr 12, 2024
1 parent 2c5d280 commit 1922ae6
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
<div align="center">

# asdf-clj-kondo [![Build](https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/test.yml/badge.svg)](https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/test.yml) [![Lint](https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/lint.yml/badge.svg)](https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/lint.yml)

[clj-kondo](https://github.com/clj-kondo/clj-kondo) plugin for the [asdf version manager](https://asdf-vm.com).
# asdf-clj-kondo
[![GitHub Actions Test Status][ci-actions-test-badge]][ci-actions-test]
[![GitHub Actions Lint Status][ci-actions-lint-badge]][ci-actions-lint]
[![CircleCI Lint Status][ci-circleci-lint-badge]][ci-circleci-lint]
[![License][license-badge]][license]

[ci-actions-test-badge]: https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/test.yml/badge.svg
[ci-actions-test]: https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/test.yml
[ci-actions-lint-badge]: https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/lint.yml/badge.svg
[ci-actions-lint]: https://github.com/rynkowsg/asdf-clj-kondo/actions/workflows/lint.yml
[ci-circleci-lint-badge]: https://circleci.com/gh/rynkowsg/asdf-clj-kondo.svg?style=shield
[ci-circleci-lint]: https://circleci.com/gh/rynkowsg/asdf-clj-kondo
[license-badge]: https://img.shields.io/badge/license-MIT-lightgrey.svg
[license]: LICENSE

[clj-kondo] plugin for the [asdf version manager][asdf-website].

[asdf-website]: https://asdf-vm.com
[asdf-repo]: https://github.com/asdf-vm/asdf
[clj-kondo]: https://github.com/clj-kondo/clj-kondo

</div>


## Contents

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

## Dependencies
Expand Down Expand Up @@ -41,14 +58,8 @@ asdf global clj-kondo latest
clj-kondo --help
```

Check [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/rynkowsg/asdf-clj-kondo/graphs/contributors)!
Check [asdf][asdf-repo] readme for more instructions on how to install & manage versions.

## License

Licensed under the [MIT license](LICENSE).
Licensed under the [MIT license][license].

0 comments on commit 1922ae6

Please sign in to comment.