From 42a6577b47a42275d1ea19bc0cf6ed7b565a82a4 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sun, 20 Jun 2021 15:29:44 +0200
Subject: README: Add real information

The previous README was just a quick usage note for others when I needed
to ask a question on IRC.
---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

(limited to 'README.md')

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).
-- 
cgit v1.2.3