Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add readthedoc link and badges #36

Merged
merged 1 commit into from
Nov 4, 2020
Merged

Add readthedoc link and badges #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ cookiecutter-homeassistant-custom-component
.. badges-begin

| |Status| |CalVer| |License|
| |Read the Docs|
| |pre-commit| |Black|

.. |Status| image:: https://badgen.net/badge/status/alpha/d8624d
Expand All @@ -16,6 +17,9 @@ cookiecutter-homeassistant-custom-component
.. |License| image:: https://img.shields.io/github/license/oncleben31/cookiecutter-homeassistant-custom-component
:target: https://opensource.org/licenses/MIT
:alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/cookiecutter-homeassistant-custom-component/latest.svg?label=Read%20the%20Docs
:target: https://cookiecutter-homeassistant-custom-component.readthedocs.io/
:alt: Read the documentation at https://cookiecutter-homeassistant-custom-component.readthedocs.io/
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
Expand All @@ -33,6 +37,10 @@ blueprint_ template.
This project is the fusion of `cookiecutter-homeassistant-component`_, blueprint_
and `cookiecutter-hypermodern-python`_ projects.

✨📚✨ `Read the full documentation`__

__ https://cookiecutter-homeassistant-custom-component.readthedocs.io/


Usage
=====
Expand All @@ -54,8 +62,8 @@ Features
- HACS_ ready
- Continuous integration with `GitHub Actions`_

You can find a repository created with this cookiecutter template in the
`cookiecutter-homeassistant-custom-component-instance`_ example.
You can find a repository created with this cookiecutter template
in the `cookiecutter-homeassistant-custom-component-instance`_ example.

.. features-end

Expand Down
14 changes: 9 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ Home Assistant custom component Cookiecutter
:start-after: badges-begin
:end-before: badges-end

Cookiecutter_ template for a Home Assistant custom component
based on the `blueprint`_ repository.
Cookiecutter_ template for a `Home Assistant`_ custom component based
on the blueprint_ template.

This project is the fusion of `cookiecutter-homeassistant-component`_,
blueprint_
and `cookiecutter-hypermodern-python`_ projects.


Usage
Expand All @@ -43,9 +47,9 @@ FAQ

*What is this project about?*

The mission of this project is to provide Home Assistant custom component developers a
ready-to-use template with best practices from `Home Assistant developers documentation`_ and from
`Hypermodern Python`_ blog articles.
The mission of this project is to provide Home Assistant custom component developers
a ready-to-use template with best practices from `Home Assistant developers documentation`_
and from `Hypermodern Python`_ blog articles.

.. include:: ../README.rst
:start-after: references-begin
Expand Down