1 files changed, 46 insertions, 15 deletions
diff --git a/pkgs/by-name/ba/back/README.md b/pkgs/by-name/ba/back/README.md
index 4bbd9c0..222ccf3 100644
--- a/pkgs/by-name/ba/back/README.md
+++ b/pkgs/by-name/ba/back/README.md
@@ -17,29 +17,60 @@ If not, see <https://www.gnu.org/licenses/agpl.txt>.
 
 ## Usage
 
-Currently, `back` only visualizes a `git-bug` repository. As such it takes exactly one
-argument, being the repository to visualize.
-The server is than started at `http://127.0.0.1:8000` and provides access to the issues
-(bugs) tracked via `git-bug`.
+`back` is modelled after `cgit`, only for `git-bug` initialized repositories. The server is than
+started at `http://127.0.0.1:8000` and provides access to the issues (bugs) tracked via `git-bug`,
+via multiple routes:
 
-### Note
+### `/`
+
+The default index is a list of all repositories that have `git-bug` data in them.
+
+### `<repo_path>/issues/<state>`
+
+This path displays all issues in `<state>` (i.e., open or closed) for the repository at
+`<repo_path>`.
+
+### `<repo_path>/issue/<issue_id>`
+
+Displays the actual issue with `id` `<issue_id>`. Beware, that the `<isuse_id>` is sourced from the
+actual git object associated with the issue create commit. As such, it is not the same ID, as
+displayed by the `git-bug` CLI.
+
+### `<repo_path>/issues/feed`
+
+An RSS feed usable to subscribe to. This includes all issues and all comments of issues.
 
-`back` needs write access to the repository, because of internal `gix` and `git` object
-reasons.
+## Configuration file
 
-## Relevant Environment Variables
+The config file is passed to `back` via the first command line argument. It is written in JSON.
+An example configuration file is available at [`./contrib/config.json`](./contrib/config.json).
 
-### `ROCKET_PORT`
+Following keys are required:
 
-> Default: 8000
+### `source_code_repository_url`
 
-This is the port the server binds to.
+The URL to the source code of this instance of `back`.
 
-### `SOURCE_CODE_REPOSITORY_URL`
+### `root_url`
+
+The root URL this instance of `back` is hosted at. For example: `https://issues.foss-syndicate.org`.
+This is required by the RSS feed to generate links to the various issues/comments.
+
+### `scan_path`
+
+The path under which to search for the repositories as specified by the `projects.list` file. This
+is semantically the same as `cgit`'s `scan-path`.
+
+### `project_list`
+
+The path to the file specifying the repositories to search. A repository path per line. This is
+semantically the same as `cgit`'s `project-list`.
+
+### Note
 
-The URL to the back's source.
+`back` needs write access to the repository, because of internal `gix` and `git` object reasons.
 
 ## Licensing
 
-This project complies with the REUSE v3.3 specification. This means that every file
-clearly states its copyright.
+This project complies with the REUSE v3.3 specification. This means that every file clearly states
+its copyright.