From 3365c474a8a7d20dcdae85b58bdb8bca637d6387 Mon Sep 17 00:00:00 2001 From: Ian Fijolek Date: Sun, 18 Aug 2024 11:10:49 -0700 Subject: [PATCH] Update documentation for forked repos --- README.md | 8 ++++++++ unhacs/main.py | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f22a1d..614af53 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,14 @@ If you already have a list of packages in a file, you can add them all at once u unhacs add --file ``` +### Add a component from a forked Home Assistant Core repository + +To add a component from a fork of home-assistant/core, use the `--forked-component` flag followed by the URL of the forked repository and then specify the branch with the `--branch` flag: + +```bash +unhacs add --forked-component --branch +``` + ### List packages To list all installed packages, use the `list` command: diff --git a/unhacs/main.py b/unhacs/main.py index 4834593..f62b1a4 100644 --- a/unhacs/main.py +++ b/unhacs/main.py @@ -91,7 +91,7 @@ def parse_args(): "--branch", "-b", type=str, - help="For foked types only, branch that should be used.", + help="For forked types only, branch that should be used.", ) add_parser.add_argument( "--update",