From 15fb1896bf5b56d54cb1e393996cf140c67f914d Mon Sep 17 00:00:00 2001 From: Ilshat Sultanov Date: Sun, 10 Apr 2022 03:35:32 +0300 Subject: [PATCH] Add badges --- readme.adoc | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/readme.adoc b/readme.adoc index 758698f..1610eb0 100644 --- a/readme.adoc +++ b/readme.adoc @@ -1,28 +1,25 @@ -= tools.project +image:https://img.shields.io/github/license/lazy-cat-io/tools.project[license,link=license] +image:https://img.shields.io/github/v/release/lazy-cat-io/tools.project.svg)[https://github.com/lazy-cat-io/tools.project/releases] +image:https://github.com/lazy-cat-io/tools.project/actions/workflows/build.yaml/badge.svg[https://github.com/lazy-cat-io/tools.project/actions/workflows/build.yml] + +image:https://img.shields.io/clojars/v/io.lazy-cat/tools.project.svg[clojars,link=https://clojars.org/io.lazy-cat/tools.project] + +== tools.project A project management tool. **Status**: alpha -== Features +=== Features - Unify a project manifest - Collect dynamic metadata of builds at compile time (e.g. uberjar step) and use the metadata at runtime - Transform a project manifest to https://github.com/seancorfield/build-clj[io.github.seancorfield/build-clj] format - Manage project version -== Roadmap - -- [ ] Stabilize the API -- [ ] Add validation using `malli` schemas -- [ ] Use `rewrite-edn` to preserve the manifest formatting style -- [ ] Add versioning support for `semver`, `git flow` -- [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)` -- [ ] Add support for `mono repositories` - -== Getting started +=== Getting started -=== Installation +==== Installation Add the following dependency in your project: @@ -38,7 +35,7 @@ Add the following dependency in your project: io.lazy-cat/tools.project {:mvn/version "N/A"} ---- -=== Configuration +==== Configuration Add the project manifest to the project root directory. @@ -233,6 +230,15 @@ How to add `BUILD_NUMBER` on GitHub Actions: echo 'BUILD_NUMBER=${{ github.run_number }}' >> $GITHUB_ENV; ---- -== License +=== Roadmap + +- [ ] Stabilize the API +- [ ] Add validation using `malli` schemas +- [ ] Use `rewrite-edn` to preserve the manifest formatting style +- [ ] Add versioning support for `semver`, `git flow` +- [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)` +- [ ] Add support for `mono repositories` + +=== License link:license[Copyright © 2022 lazy-cat.io]