chore: updated readme
This commit is contained in:
12
README.md
12
README.md
@@ -37,6 +37,14 @@ separate API-crate and CLI coverage status.
|
|||||||
Build the workspace with `cargo build`; the CLI executable is written to
|
Build the workspace with `cargo build`; the CLI executable is written to
|
||||||
`target/debug/gotcha`. To build only the CLI, use `cargo build -p gotcha-cli`.
|
`target/debug/gotcha`. To build only the CLI, use `cargo build -p gotcha-cli`.
|
||||||
|
|
||||||
|
Create an optimized release build of the CLI with:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo build --release -p gotcha-cli
|
||||||
|
```
|
||||||
|
|
||||||
|
The executable is written to `target/release/gotcha`.
|
||||||
|
|
||||||
Store each server profile in `~/.config/gotcha/config`:
|
Store each server profile in `~/.config/gotcha/config`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -69,6 +77,10 @@ servers:
|
|||||||
url: https://gitea.example.com
|
url: https://gitea.example.com
|
||||||
token: your-token
|
token: your-token
|
||||||
provider: gitea
|
provider: gitea
|
||||||
|
forgejo.example.com:
|
||||||
|
url: https://forgejo.example.com
|
||||||
|
token: your-token
|
||||||
|
provider: forgejo
|
||||||
```
|
```
|
||||||
|
|
||||||
Inside a Git repository, Gotcha matches its remotes to these server URLs and
|
Inside a Git repository, Gotcha matches its remotes to these server URLs and
|
||||||
|
|||||||
Reference in New Issue
Block a user