From 7f06e995a812f9cc922b58fc89bc458a4d23955d Mon Sep 17 00:00:00 2001 From: Oncleben31 Date: Sat, 14 Nov 2020 08:28:20 +0100 Subject: [PATCH] Add a known limitations section in documentation (#64) * Add known limitation section in documentation * Text reviewd --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.rst b/README.rst index 94d8863..75d9d0b 100644 --- a/README.rst +++ b/README.rst @@ -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