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

Ruben Hönle created 1 year ago

Change summary

README.md | 12 ++++++++++++
1 file changed, 12 insertions(+)

Detailed changes

README.md

@@ -515,6 +515,8 @@ on the server it’ll be created.
 git push origin main
 ```
 
+### Nested Repositories
+
 Repositories can be nested too:
 
 ```sh
@@ -526,6 +528,16 @@ git remote add charm ssh://localhost:23231/charmbracelet/icecream
 git push charm main
 ```
 
+### Mirrors
+
+You can also *import* repositories from any public remote. Use the `repo import` command.
+
+```sh
+ssh -p 23231 localhost repo import soft-serve https://github.com/charmbracelet/soft-serve
+```
+
+Use `--mirror` or `-m` to mark the repository as a *pull* mirror.
+
 ### Deleting Repositories
 
 You can delete repositories using the `repo delete <repo>` command.