Skip to content

Commit a3e46fd

Browse files
committed
some steps towards a readme
1 parent b2aabf7 commit a3e46fd

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
11
# Radkummerkasten
2+
3+
<!-- badges -->
4+
<!--// [![stable version][stable-version-badge]][stable-version-link] //-->
5+
<!--// [![downloads (pypi)][downloads-pypi-badge]][downloads-pypi-link] //-->
6+
<br />
7+
[![Unit tests][test-status-badge]][test-status-link]
8+
<!--//[![Documentation Status][rtd-status-badge]][rtd-status-link] //-->
9+
[![Coverage][coverage-badge]][coverage-link]
10+
<br />
11+
12+
13+
14+
TBA
15+
16+
17+
## License
18+
19+
This work is licensed under GNU General Public License v3.0.
20+
21+
`SPDX-License-Identifier: GPL-3.0-only`
22+
23+
24+
<!-- links used throughout the document -->
25+
26+
<!-- (1) badges -->
27+
[coverage-badge]: https://codecov.io/gh/christophfink/radkummerkasten.at/graph/badge.svg?token=W8M41NEL56
28+
[coverage-link]: https://codecov.io/gh/christophfink/radkummerkasten.at/
29+
[downloads-pypi-badge]: https://static.pepy.tech/personalized-badge/radkummerkasten?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads%20(pypi)
30+
[downloads-pypi-link]: https://pypi.org/project/radkummerkasten/
31+
[rtd-status-badge]: https://readthedocs.org/projects/radkummerkasten/badge/?version=stable
32+
[rtd-status-link]: https://radkummerkasten.readthedocs.io/
33+
[stable-version-badge]: https://img.shields.io/pypi/v/radkummerkasten?label=Stable
34+
[stable-version-link]: https://github.com/christophfink/radkummerkasten.at/releases
35+
[test-status-badge]: https://github.com/christophfink/radkummerkasten.at/actions/workflows/test.yml/badge.svg
36+
[test-status-link]: https://github.com/christophfink/radkummerkasten.at/actions/workflows/test.yml
37+
38+
<!-- (2) other links -->

0 commit comments

Comments
 (0)