Skip to content

Commit 521226d

Browse files
liblafliblaf
committed
docs: update README template formatting and badges
- Improve whitespace and alignment in template - Add "Lines of Code" badge - Reorganize badge sections with tangerine comments - Update test command reference to use mise - Change rainbow line image source
1 parent 8b5d82f commit 521226d

1 file changed

Lines changed: 28 additions & 21 deletions

File tree

‎template/README.md.jinja‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
<!-- -*- mode: markdown; -*- -->
22

3-
<div align="center" markdown><a name="readme-top"></a>
3+
<div align="center" markdown>
4+
<a name="readme-top"></a>
45

56
<img height="160" src="https://api.iconify.design/logos/python.svg" />
67

78
# {{ project_name }}
89

910
TODO: DESCRIPTION <br />
10-
[**Explore the docs »**](https://{{github_user}}.github.io/{{github_repo}}/)
11+
[**Explore the docs »**](https://{{ github_user }}.github.io/{{ github_repo }}/)
1112

12-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/{{package_name}}?logo=PyPI&label=Downloads)](https://pypi.org/project/{{package_name}})
13-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/{{package_name}}?logo=Python&label=Python)](https://pypi.org/project/{{package_name}})
14-
[![PyPI - Version](https://img.shields.io/pypi/v/{{package_name}}?logo=PyPI&label=PyPI)](https://pypi.org/project/{{package_name}})
15-
[![Codecov](https://img.shields.io/codecov/c/github/{{github_user}}/{{github_repo}}?logo=Codecov&label=Coverage)](https://codecov.io/gh/{{github_user}}/{{github_repo}})
16-
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/{{github_user}}/{{github_repo}}/test.yaml?logo=GitHub%20Actions&label=Test)](https://github.com/{{github_user}}/{{github_repo}}/actions/workflows/test.yaml)
13+
<!-- tangerine-start: badges/python.md.jinja -->
14+
15+
[![Codecov](https://img.shields.io/codecov/c/github/{{ github_user }}/{{ github_repo }}?logo=Codecov&label=Coverage)](https://codecov.io/gh/{{ github_user }}/{{ github_repo }})
16+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/{{ github_user }}/{{ github_repo }}/test.yaml?logo=GitHub%20Actions&label=Test)](https://github.com/{{ github_user }}/{{ github_repo }}/actions/workflows/test.yaml)
17+
[![Lines of Code](https://tokei.rs/b1/github.com/{{ github_user }}/{{ github_repo }}?category=code&label=Lines%20of%20Code&style=flat)](https://github.com/{{ github_user }}/{{ github_repo }})
18+
<br />
19+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/{{ package_name }}?logo=PyPI&label=Downloads)](https://pypi.org/project/{{ package_name }})
20+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/{{ package_name }}?logo=Python&label=Python)](https://pypi.org/project/{{ package_name }})
21+
[![PyPI - Version](https://img.shields.io/pypi/v/{{ package_name }}?logo=PyPI&label=PyPI)](https://pypi.org/project/{{ package_name }})
1722
<br />
18-
[![GitHub Contributors](https://img.shields.io/github/contributors/{{github_user}}/{{github_repo}}?logo=GitHub&label=Contributors)](https://github.com/{{github_user}}/{{github_repo}}/graphs/contributors)
19-
[![GitHub Forks](https://img.shields.io/github/forks/{{github_user}}/{{github_repo}})](https://github.com/{{github_user}}/{{github_repo}}/forks)
20-
[![GitHub Repo Stars](https://img.shields.io/github/stars/{{github_user}}/{{github_repo}})](https://github.com/{{github_user}}/{{github_repo}}/stargazers)
21-
[![GitHub Issues](https://img.shields.io/github/issues/{{github_user}}/{{github_repo}}?logo=GitHub&label=Issues)](https://github.com/{{github_user}}/{{github_repo}}/issues)
22-
[![GitHub License](https://img.shields.io/github/license/{{github_user}}/{{github_repo}}?label=License)](https://github.com/{{github_user}}/{{github_repo}}/blob/main/LICENSE)
23+
[![GitHub Contributors](https://img.shields.io/github/contributors/{{ github_user }}/{{ github_repo }}?logo=GitHub&label=Contributors)](https://github.com/{{ github_user }}/{{ github_repo }}/graphs/contributors)
24+
[![GitHub Issues](https://img.shields.io/github/issues/{{ github_user }}/{{ github_repo }}?logo=GitHub&label=Issues)](https://github.com/{{ github_user }}/{{ github_repo }}/issues)
25+
[![GitHub License](https://img.shields.io/github/license/{{ github_user }}/{{ github_repo }}?label=License)](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/LICENSE)
26+
[![GitHub Forks](https://img.shields.io/github/forks/{{ github_user }}/{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/forks)
27+
[![GitHub Repo Stars](https://img.shields.io/github/stars/{{ github_user }}/{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/stargazers)
28+
29+
<!-- tangerine-end -->
2330

24-
[Changelog](https://github.com/{{github_user}}/{{github_repo}}/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/{{github_user}}/{{github_repo}}/issues) · [Request Feature](https://github.com/{{github_user}}/{{github_repo}}/issues)
31+
[Changelog](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/{{ github_user }}/{{ github_repo }}/issues) · [Request Feature](https://github.com/{{ github_user}}/{{ github_repo }}/issues)
2532

26-
![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
33+
![](https://cdn.jsdelivr.net/gh/andreasbm/readme/assets/lines/rainbow.png)
2734

2835
</div>
2936

@@ -55,14 +62,14 @@ $ uv add {{ package_name }}
5562

5663
You can use Github Codespaces for online development:
5764

58-
[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{github_user}}/{{github_repo}})
65+
[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{ github_user }}/{{ github_repo }})
5966

6067
Or clone it for local development:
6168

6269
```bash
6370
$ gh repo clone {{ github_user }}/{{ github_repo }}
6471
$ cd {{ github_repo }}
65-
$ just test
72+
$ mise run test
6673
```
6774

6875
<div align="right" markdown>
@@ -73,11 +80,11 @@ $ just test
7380

7481
## 🤝 Contributing
7582

76-
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/{{github_user}}/{{github_repo}}/issues) to get stuck in to show us what you're made of.
83+
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/{{ github_user }}/{{ github_repo }}/issues) to get stuck in to show us what you're made of.
7784

78-
[![](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/{{github_user}}/{{github_repo}}/pulls)
85+
[![](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/{{ github_user }}/{{ github_repo }}/pulls)
7986

80-
[![](https://contrib.rocks/image?repo={{github_user}}%2F{{github_repo}})](https://github.com/{{github_user}}/{{github_repo}}/graphs/contributors)
87+
[![](https://contrib.rocks/image?repo={{ github_user }}%2F{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/graphs/contributors)
8188

8289
<div align="right" markdown>
8390

@@ -105,5 +112,5 @@ Contributions of all types are more than welcome, if you are interested in contr
105112

106113
#### 📝 License
107114

108-
Copyright © {{ "%Y" | strftime }} [{{ author_name }}](https://github.com/{{github_user}}). <br />
109-
This project is [MIT](https://github.com/{{github_user}}/{{github_repo}}/blob/main/LICENSE) licensed.
115+
Copyright © {{ "%Y" | strftime }} [{{ author_name }}](https://github.com/{{ github_user }}). <br />
116+
This project is [MIT](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/LICENSE) licensed.

0 commit comments

Comments
 (0)