aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2021-06-20 15:29:44 +0200
committerTeddy Wing2021-06-20 15:34:56 +0200
commit42a6577b47a42275d1ea19bc0cf6ed7b565a82a4 (patch)
tree1e7b95fe1ff8a38dcc0e02a558b3598412e04088 /README.md
parent4e79052816233a7ad261e76154832b89b0614c0f (diff)
downloadreflectub-42a6577b47a42275d1ea19bc0cf6ed7b565a82a4.tar.bz2
README: Add real informationv0.0.1
The previous README was just a quick usage note for others when I needed to ask a question on IRC.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index e6a56eb..37344cf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
+reflectub
+=========
+
+Mirror all of a user’s GitHub repositories. This command can be run regularly to
+fetch updates and new repositories from GitHub. It’s designed to support Git web
+hosting services like CGit.
+
+
## Usage
- cargo run -- --database test.db <github-username> /tmp/
+ $ reflectub --database reflectub.db <github-username> /path/to/repos/
+
+
+## Install
+
+ $ cargo install --git https://github.com/teddywing/reflectub.git
+
+
+## License
+Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).