Skip to content

Commit 655a05e

Browse files
committed
feat: add the description to the README
1 parent ffffcf6 commit 655a05e

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

changelog.d/+1f89046c.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add the description to `README.md`.

template/README.md.jinja

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
[![Supported Python versions](https://img.shields.io/pypi/pyversions/{{ distribution_name }}?logo=python)](https://pypi.org/project/{{ distribution_name }}/)
55
[![CI](https://img.shields.io/github/actions/workflow/status/{{ repository_path }}/ci.yaml?branch=main&logo=github&label=CI)](https://github.com/{{ repository_path }}/actions/workflows/ci.yaml)
66
[![License](https://img.shields.io/github/license/{{ repository_path }})](https://github.com/{{ repository_path }}/blob/main/LICENSE)
7-
7+
{% if description %}
8+
{{ description }}.
9+
{% endif %}
810
## Installation
911

1012
Install `{{ distribution_name }}` using [pip](https://pip.pypa.io/):

0 commit comments

Comments
 (0)