From 9fdcad099883c532f990acb2afbdd10118db4476 Mon Sep 17 00:00:00 2001 From: Corey Oordt Date: Sun, 26 Jun 2022 09:13:46 -0500 Subject: [PATCH] Added badges to the readme --- README.md | 16 ++++++++++++++++ docsrc/index.md | 5 +++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index 375cfcd..206d591 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # Cookie Composer + + +[![PyPI](https://img.shields.io/pypi/v/cookie-composer)][pypi_] +[![Status](https://img.shields.io/pypi/status/cookie-composer)][status] +[![Python Version](https://img.shields.io/pypi/pyversions/cookie-composer)][python version] +[![License](https://img.shields.io/pypi/l/cookie-composer)][license] +[![Coverage Status](https://coveralls.io/repos/github/coordt/cookie-composer/badge.svg?branch=master)][coveralls] + +[pypi_]: https://pypi.org/project/{{cookiecutter.project_name}}/ +[status]: https://pypi.org/project/{{cookiecutter.project_name}}/ +[python version]: https://pypi.org/project/{{cookiecutter.project_name}} +[license]: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/blob/main/LICENSE +[coveralls]: https://coveralls.io/github/coordt/cookie-composer?branch=master + + + Cookie composer builds on the [cookie cutter](https://github.com/cookiecutter/cookiecutter) project to generate projects based on one or more cookiecutter templates. ## Goals diff --git a/docsrc/index.md b/docsrc/index.md index 7201374..34695df 100644 --- a/docsrc/index.md +++ b/docsrc/index.md @@ -1,4 +1,9 @@ +# Cookie composer + ```{include} ../README.md +--- +start-after: +--- ``` ```{toctree}