Skip to content

Commit 9ba23ab

Browse files
committed
enh: cleanup readme
1 parent 2d60fa7 commit 9ba23ab

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

template/README.md.jinja

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# {{ project_name }}
1+
# Welcome to {{ project_name }}
22

3-
| | |
4-
|---|----------------|
5-
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) {% if use_rtd %}[![Documentation](https://readthedocs.org/projects/{{project_slug}}/badge/?version=latest)](https://{{project_slug}}.readthedocs.io/en/latest/?badge=latest) {% endif %} |
6-
| Meta | [![{{ license }}](https://img.shields.io/pypi/l/{{project_slug}}.svg)](LICENSE) [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](.github/CODE_OF_CONDUCT.md) |
7-
| Automation | |
3+
| | |
4+
|--------|--------|
5+
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) {% if use_rtd %}[![Documentation](https://readthedocs.org/projects/{{project_slug}}/badge/?version=latest)](https://{{project_slug}}.readthedocs.io/en/latest/?badge=latest){% endif %} |
6+
| Meta | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
87

9-
_{{ package_description }}_
8+
*TODO: the above badges that indicate python version and package version will only work if your package is on PyPI.
9+
If you don't plan to publish to PyPI, you can remove them.*
1010

11-
TODO: Add more about what the package does here.
11+
{{ project_name }} is a project that (describe what it does here).
1212

1313
## Get started
1414

0 commit comments

Comments
 (0)