aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-03-27 22:09:05 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-03-29 00:45:48 +0300
commit96ccf79d46adb2d6b49c67e3e6ad59512d67da65 (patch)
tree30d924907a180c465799d7c575b0b833f51a676c /README.md
parentdedupe the code a bit (diff)
downloadcgitize-96ccf79d46adb2d6b49c67e3e6ad59512d67da65.tar.gz
cgitize-96ccf79d46adb2d6b49c67e3e6ad59512d67da65.zip
rename the project to "cgitize"
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7c2f9cb..3a984bc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-cgit repos
-==========
+cgitize
+=======
[![Test](https://github.com/egor-tensin/cgit-repos/workflows/Test/badge.svg)](https://github.com/egor-tensin/cgit-repos/actions?query=workflow%3ATest)
@@ -11,7 +11,7 @@ Usage
Adjust the config in [examples/cgit-repos.conf] and pass it using the
`--config` parameter:
- > python3 -m cgit.repos.main --config path/to/cgit-repos.conf
+ > python3 -m cgitize.main --config path/to/cgit-repos.conf
The repository list is stored in my_repos.py (the `my_repos` setting in the
config).
@@ -25,7 +25,7 @@ Make sure the required keys are loaded to a ssh-agent.
### Docker
-The image is **egortensin/cgit-repos**.
+The image is **egortensin/cgitize**.
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
@@ -37,7 +37,7 @@ For example:
-v "/path/to/config:/etc/cgit-repos:ro" \
-v "$SSH_AUTH_SOCK:/var/run/cgit-repos/ssh-agent.sock" \
-v "/path/to/output:/var/tmp/cgit-repos/output" \
- egortensin/cgit-repos
+ egortensin/cgitize
### my_repos.py