diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 57c6ed7f..5c3780c7 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -1,11 +1,12 @@ {% set is_open_source = cookiecutter.open_source_license != 'Not open source' -%} + # {{ cookiecutter.project_name }} {% if is_open_source %} -[![pypi](https://img.shields.io/pypi/v/{{ cookiecutter.project_slug }}.svg)](https://pypi.org/project/{{ cookiecutter.project_slug }}/) -[![python](https://img.shields.io/pypi/pyversions/{{ cookiecutter.project_slug }}.svg)](https://pypi.org/project/{{ cookiecutter.project_slug }}/) -[![Build Status](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/dev.yml/badge.svg)](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/dev.yml) -[![codecov](https://codecov.io/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/branch/main/graphs/badge.svg)](https://codecov.io/github/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}) +[![pypi](https://img.shields.io/pypi/v/{{ cookiecutter.project_slug }}.svg)]( cookiecutter.project_slug }}/) +[![python](https://img.shields.io/pypi/pyversions/{{ cookiecutter.project_slug }}.svg)]( cookiecutter.project_slug }}/) +[![Build Status](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/dev.yml/badge.svg)]( cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/dev.yml) +[![codecov](https://codecov.io/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/branch/main/graphs/badge.svg)]( cookiecutter.github_username }}/{{ cookiecutter.project_slug }}) {% else %} {% endif %} @@ -13,9 +14,10 @@ {{ cookiecutter.project_short_description }} {% if is_open_source %} + * Documentation: -* GitHub: -* PyPI: +* GitHub: < cookiecutter.github_username }}/{{ cookiecutter.project_slug }}> +* PyPI: < cookiecutter.project_slug }}/> * Free software: {{ cookiecutter.open_source_license }} {% endif %} @@ -25,4 +27,4 @@ ## Credits -This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template. +This package was created with [CookieCutter](https://github.com/euanmason/cookiecutter-pypackage) which is based on [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template.