Skip to content

Commit 15fb189

Browse files
committed
Add badges
1 parent dfbb138 commit 15fb189

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

readme.adoc

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
1-
= tools.project
1+
image:https://img.shields.io/github/license/lazy-cat-io/tools.project[license,link=license]
2+
image:https://img.shields.io/github/v/release/lazy-cat-io/tools.project.svg)[https://github.com/lazy-cat-io/tools.project/releases]
3+
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]
4+
5+
image:https://img.shields.io/clojars/v/io.lazy-cat/tools.project.svg[clojars,link=https://clojars.org/io.lazy-cat/tools.project]
6+
7+
== tools.project
28

39
A project management tool.
410

511
**Status**: alpha
612

7-
== Features
13+
=== Features
814

915
- Unify a project manifest
1016
- Collect dynamic metadata of builds at compile time (e.g. uberjar step) and use the metadata at runtime
1117
- Transform a project manifest to https://github.com/seancorfield/build-clj[io.github.seancorfield/build-clj] format
1218
- Manage project version
1319

14-
== Roadmap
15-
16-
- [ ] Stabilize the API
17-
- [ ] Add validation using `malli` schemas
18-
- [ ] Use `rewrite-edn` to preserve the manifest formatting style
19-
- [ ] Add versioning support for `semver`, `git flow`
20-
- [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)`
21-
- [ ] Add support for `mono repositories`
22-
23-
== Getting started
20+
=== Getting started
2421

25-
=== Installation
22+
==== Installation
2623

2724
Add the following dependency in your project:
2825

@@ -38,7 +35,7 @@ Add the following dependency in your project:
3835
io.lazy-cat/tools.project {:mvn/version "N/A"}
3936
----
4037

41-
=== Configuration
38+
==== Configuration
4239

4340
Add the project manifest to the project root directory.
4441

@@ -233,6 +230,15 @@ How to add `BUILD_NUMBER` on GitHub Actions:
233230
echo 'BUILD_NUMBER=${{ github.run_number }}' >> $GITHUB_ENV;
234231
----
235232

236-
== License
233+
=== Roadmap
234+
235+
- [ ] Stabilize the API
236+
- [ ] Add validation using `malli` schemas
237+
- [ ] Use `rewrite-edn` to preserve the manifest formatting style
238+
- [ ] Add versioning support for `semver`, `git flow`
239+
- [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)`
240+
- [ ] Add support for `mono repositories`
241+
242+
=== License
237243

238244
link:license[Copyright © 2022 lazy-cat.io]

0 commit comments

Comments
 (0)