README file.

2018-08-05 00:55:14 -05:00 · 2018-08-05 00:55:14 -05:00 · 032a9f914e
parent faa06d5607
commit 032a9f914e
1 changed files with 10 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,10 @@
+# goget-proxy
+
+Vanity imports for golang. Ensures only serves existing repos with Gitea API.
+
+## Configuration
+
+* `GITEA_HOST` - Path to Gitea instance, used for API and generating URIs
+* `GITEA_API_TOKEN` - Gitea API token to ensure repo exists
+* `SHORT_HOST` - Vanity hostname
+* `HTTP_HOST` - Where to listen for incoming requests