Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
siketyan committed Dec 31, 2023
1 parent ccadabd commit 6f6d9db
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ cmd = "code"
args = ["%p"]
```

> **Note**
> [!NOTE]
> `%p` will be replaced by the repository path.
### Finding path of the repository
Expand All @@ -178,6 +178,18 @@ ghr path --host=github.com # Host root
ghr path --host=github.com --owner=<owner> # Owner root of the specified host
```

### Syncing repositories and their state

> [!WARNING]
> This feature is experimental.
ghr supports dumping and restoring the current branch and remotes of managed repositories.

```shell
ghr sync dump > repositories.toml
ghr sync restore < repositories.toml
```

## 🛠 Customising
You can change the root of repositories managed by ghr by setting environment variable `GHR_ROOT` in your shell profile.

Expand Down

0 comments on commit 6f6d9db

Please sign in to comment.