From 8c8be9b34dc19428bf96d7e924993d880253449d Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Wed, 14 Aug 2019 11:07:05 +0300
Subject: README update
---
README.md | 23 +++++++++++++++++------
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 6031958..81c4267 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ cgit.
Usage
-----
-Update the config in [examples/cgit-repos.conf] and pass it using the
+Adjust the config in [examples/cgit-repos.conf] and pass it using the
`--config` parameter:
> python3 -m pull.main --config path/to/cgit-repos.conf
@@ -17,18 +17,18 @@ config).
See [examples/my_repos.py] for an example.
pull/main.py calls git, which might call ssh internally.
-Make sure the required keys are loaded to the ssh-agent.
+Make sure the required keys are loaded to a ssh-agent.
[examples/cgit-repos.conf]: examples/cgit-repos.conf
[examples/my_repos.py]: examples/my_repos.py
### Docker
-The image is `egortensin/pull-cgit-repos`.
-The container reads the config from /etc/cgit-repos/cgit-repos.conf and updates
-the repositories in /var/tmp/cgit-repos/output.
+The image is **egortensin/pull-cgit-repos**.
+The container reads the config from */etc/cgit-repos/cgit-repos.conf* and
+writes the repositories to */var/tmp/cgit-repos/output*.
If SSH is required, the socket should be mapped to
-/var/run/cgit-repos/ssh-agent.sock.
+*/var/run/cgit-repos/ssh-agent.sock*.
For example:
@@ -38,6 +38,17 @@ For example:
-v "/path/to/output:/var/tmp/cgit-repos/output" \
egortensin/pull-cgit-repos
+### my_repos.py
+
+Change the section to which the repository belongs to using `cp --archive` (so
+that the "Idle" column isn't updated):
+
+ > cp --archive -- section1/repo section2/
+
+Update the URL of an existing repository mirror:
+
+ > git remote set-url origin ssh://git@examples.com/username/name.git
+
Development
-----------
--
cgit v1.2.3