Skip to content

Commit a3542d8

Browse files
committed
extend readme
1 parent a7bbb6f commit a3542d8

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Collect and share metadata of CI/CD processes.
1717
* [Content](#content)
1818
* [Schema](#schema)
1919
* [Frontend](#frontend)
20-
* [Backend (data production)](#backend-data-production)
20+
* [Command Line Tool](#command-line-tool)
2121

2222
<!-- vim-markdown-toc -->
2323

@@ -118,14 +118,20 @@ Ideas beyond the initial prototype:
118118
- header allows for sorting
119119
- header allows for filtering
120120

121-
## Backend (data production)
121+
## Command Line Tool
122122

123123
The backend part of this project runs in the metadata CI job and provides and easy way to produce a `__metadata__.json` with the items wanted.
124124

125-
Ideas beyond the initial prototype:
125+
``` shell
126+
$ pipx install cimd
127+
$ ciwd add coverage "85%" --label "Code Coverage"
128+
ADD: coverage (85%)
126129

127-
- create metadata items based on log output (similar to coverage expressions)
128-
- create metadata items by fetching job-based `__metadata__.json` documents (and merge)
130+
$ cimd list
131+
Key Value Additional Fields
132+
-------- ------- --------------------
133+
coverage 85% label: Code Coverage
134+
```
129135

130136

131137
[poetry-link]: https://python-poetry.org/

0 commit comments

Comments
 (0)