From f9d7696e3bc7ba984cc888bc06750734b234ac11 Mon Sep 17 00:00:00 2001 From: Benedikt Peetz Date: Fri, 6 Jun 2025 15:53:44 +0200 Subject: docs(README.md): Align with current design --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index afb70a1..deaee88 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,14 @@ issues (bugs) tracked via `git-bug`, via multiple routes: The default index is a list of all repositories that have `git-bug` data in them. -### `/issues/` +### `/issues/?query=` -This path displays all issues in `` (i.e., open or closed) for the +This path displays all issues that match the query `` for the repository at ``. ### `/issue/` -Displays the actual issue with `id` ``. Beware, that the `` -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. +Displays the actual issue with `id` ``. ### `/issues/feed` @@ -73,8 +71,8 @@ per line. This is semantically the same as `cgit`'s `project-list`. ### Note -`back` needs write access to the repository, because of internal `gix` and `git` -object reasons. +`back` needs write access to the repository, because it will generate +an entity lookup cache at `.git/git-bug-rs`. ## Licensing -- cgit 1.4.1