diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
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 |