Skip to content

Commit bbf205d

Browse files
docs: add Quick Run section to README with standalone script usage examples
1 parent 84a9d65 commit bbf205d

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,26 @@ identical.
1919
(Maintained by this repo's own
2020
[workflow](.github/workflows/update-readme-live-link.yml).)
2121

22+
## Quick Run
23+
24+
From inside this repo, sync another repo's README in one command:
25+
26+
```bash
27+
README_FILE=/path/to/other-repo/README.md \
28+
REPOSITORY=owner/other-repo \
29+
./scripts/update-live-link.sh
30+
```
31+
32+
Example, updating a sibling checkout of `documind`:
33+
34+
```bash
35+
README_FILE=../documind/README.md REPOSITORY=DevArtsLab/documind ./scripts/update-live-link.sh
36+
```
37+
38+
`README_FILE` points at the other repo's README; `REPOSITORY` is the
39+
`owner/name` to read the About URL from. Uses `gh` when installed, so a
40+
logged-in `gh` needs no token setup.
41+
2242
## Setup
2343

2444
1. Put markers in your README:

0 commit comments

Comments
 (0)