From 0e7bca80cbf0705757a9a35d5431c8baebc780da Mon Sep 17 00:00:00 2001 From: Robert Garrett Date: Mon, 21 Jul 2025 15:53:46 -0500 Subject: [PATCH] Create a short, complete explanation of req. info. I don't need to have nearly so much information explaining how to use optional command line arguments. The quirk about the "repo" needing to be a URL fragment somewhat justified the extra explanation, but that's gone now. Instead, a short, up-front section stating which bits are required and where the program will try to get them. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 524120f..b64aa53 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,24 @@ Options: -V, --version Print version ``` +### Required Information + +To function, this program requires knowledge of these items: + +- Gitea URL +- Owner of repository +- Repository name + +This info will be gathered from these locations, in order of priority: + +1. CLI argument +2. Environment variable +3. Configuration files + +It's worth noting that the "owner" is the entity that controls the repo on the Gitea instance. This will be the first part of the route in the URL: `http://demo.gitea.com/{owner}`. + +Likewise, the "repo" is what ever the Gitea instance thinks it's called -- which doesn't have to match anyone's local copy! It will be the second part of the route in the URL: `http://demo.gitea.com/{owner}/{repo}`. + ### Authentication Authentication is token-based via environment variable `RELEASE_KEY_GITEA`.