diff --git a/README.md b/README.md index be65b99e89d358b0144ac49a330936ec111fc901..5aaa2e0c657751118e26758d3da5dbe210630c94 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,37 @@ export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin +## Workflows + +There is multiple ways to use `git-bug`: + +
Native workflow +

+ Native workflow +

+ +This is the pure `git-bug` experience. As you would do with code, push and pull your bugs between git remotes. + +
+ +
Bridge workflow +

+ Bridge workflow +

+ +As `git-bug` has bridges with other bug-trackers, you can use it as your personal local remote interface. Sync with `git bug bridge pull` and `git bug bridge push`, work from your terminal, integrate into your editor, it's up to you. And it works offline ! + +
+ +
Web UI workflow (WIP) +

+ Web UI workflow +

+ +Often, projects needs to have their bug-tracker public and accept editions from anyone facing a problem. To support this workflow, `git-bug` aims to have the web UI accept external OAuth authentication and act as a public portal. However the web UI is not up to speed for that yet. Contribution are very much welcome! + +
+ ## CLI usage Create a new identity: diff --git a/misc/diagrams/webui-workflow.png b/misc/diagrams/webui-workflow.png new file mode 100644 index 0000000000000000000000000000000000000000..83d20d84ef13eb2497e2211050c47a72636ee319 Binary files /dev/null and b/misc/diagrams/webui-workflow.png differ