diff --git a/README.md b/README.md index c92947e..ec3c5e5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ CLI tools for interacting with the Gitea API. Use interactively to talk to your ## Usage ```txt -Usage: gt-tools --url --repo +Usage: gt-tool [OPTIONS] Commands: list-releases @@ -14,10 +14,11 @@ Commands: help Print this message or the help of the given subcommand(s) Options: - -u, --url [env: GTTOOL_GITEA_URL=] - -r, --repo [env: GTTOOL_FQRN=] - -h, --help Print help - -V, --version Print version + -u, --url [env: GTTOOL_GITEA_URL=] + -r, --repo [env: GTTOOL_FQRN=] + -p, --project Path to project (relative or absolute). Used to select configuration. + -h, --help Print help + -V, --version Print version ``` ### Authentication @@ -40,6 +41,12 @@ The repository name must be provided with `--repo` or `-u` on the command line, E.g.: `--repo "go-gitea/gitea"` would name the Gitea repo belonging to the go-gitea organization. +### `` + +Override the default (current-directory) project name when searching through the config files for this project's settings. + +See [configuration](#configuration) for details on format and file locations. + ### ``: One of these, defaults to `help`: