83495e2974be77622dc3cb6f40619e7ad824b820

Author
Ruben Hönle <rubenhoenle@protonmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

docs: add CLI instructions for mirrors to README (#543)

Diff

 1diff --git a/README.md b/README.md
 2index 433012760928766afa879f7a58eef327a67fbb22..7b3a4759e6af77e5c0014bd20833c6ee3df6e7da 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -515,6 +515,8 @@ on the server it’ll be created.
 6 git push origin main
 7 ```
 8 
 9+### Nested Repositories
10+
11 Repositories can be nested too:
12 
13 ```sh
14@@ -526,6 +528,16 @@ git remote add charm ssh://localhost:23231/charmbracelet/icecream
15 git push charm main
16 ```
17 
18+### Mirrors
19+
20+You can also *import* repositories from any public remote. Use the `repo import` command.
21+
22+```sh
23+ssh -p 23231 localhost repo import soft-serve https://github.com/charmbracelet/soft-serve
24+```
25+
26+Use `--mirror` or `-m` to mark the repository as a *pull* mirror.
27+
28 ### Deleting Repositories
29 
30 You can delete repositories using the `repo delete <repo>` command.