Skip to content

Commit

Permalink
Add a known limitations section in documentation (#64)
Browse files Browse the repository at this point in the history
* Add known limitation section in documentation

* Text reviewd
  • Loading branch information
oncleben31 authored Nov 14, 2020
1 parent 171965f commit 7f06e99
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,17 @@ The `Publish documentation`_ explains how to set those files
and the different options you have to integrate your custom component in the HACS network.


Known limitations
-----------------

- **If you plan to host the generated repository in a GitHub organization you will need manual modifications**.

Currently the template work well when the repostory is hosted in a GitHub individual account,
where URL name and code owner are the same.
If you want to use an organization,
it is recommended to use the name of this organization for ``github_user`` settings
and modify manually where it's needed afer generation with Cookiecutter.


.. quickstart-end
Expand Down

0 comments on commit 7f06e99

Please sign in to comment.