diff --git a/README.md b/README.md index 4d8d89b6be6f1d89c7903afec39684939b93668e..65ae528a7b3767a399171ec929df9fe78f6b35be 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ # cznicinfo -is a python module and CLI tool for (managing and) querying project and packaging information +is a python module and CLI tool for querying (and managing) project and packaging information for CZ.NIC open source projects. +The goal of `cznicinfo` is to collect packaging metadata from various repos +and minds of packaging wizards alike in order to provide unified packaging +metadata required for high quality packaging across distros. Providing such +data in easily parsable format benefits future packagers but more importantly +it allows full packaging automation. + ## status -This is currently a WIP by `jruzicka`. +This is currently in early development by `jruzicka`. + +Please see the the YAML file containing the information: +[data/cznicinfo.yaml](https://gitlab.nic.cz/packaging/cznicinfo/-/blob/master/cznicinfo/data/cznicinfo.yaml) + +## sneak peak + +Here, have a picture of CLI usage: + + diff --git a/sneak_peak.png b/sneak_peak.png new file mode 100644 index 0000000000000000000000000000000000000000..f14cf192c3c138cd076755936838edfa3a80c495 Binary files /dev/null and b/sneak_peak.png differ