about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-06-06 15:53:44 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-06-06 15:54:04 +0200
commitf9d7696e3bc7ba984cc888bc06750734b234ac11 (patch)
tree333ea03203a740b71ec86fdea51c2939ae19427f
parentfeat(treewide): Prepare for first release (diff)
downloadback-f9d7696e3bc7ba984cc888bc06750734b234ac11.zip
docs(README.md): Align with current design
-rw-r--r--README.md12
1 files 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.
 
-### `<repo_path>/issues/<state>`
+### `<repo_path>/issues/?query=<query>`
 
-This path displays all issues in `<state>` (i.e., open or closed) for the
+This path displays all issues that match the query `<query>` 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.
+Displays the actual issue with `id` `<issue_id>`.
 
 ### `<repo_path>/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