From 7cb2b5118348a5f00556d8bfd64de203cfcbc53d Mon Sep 17 00:00:00 2001
From: Simon Cornet <simon@simoncor.net>
Date: Thu, 2 Jan 2025 18:55:13 +0100
Subject: [PATCH] doc: added readme

---
 readme.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..8bcef85
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,21 @@
+# gogitlabber
+This project is inspired from the python application called gitlabber (https://github.com/ezbz/gitlabber).
+It is mainly to learn Golang. But also to make something that specifically solves my problem. :)
+
+The program can download and update all repositories you have access to on a Gitlab server.
+This works for bot gitlab.com and a selfhosted Gitlab instance. It only supports the HTTP method.
+
+# Usage
+```
+Usage: gogitlabber
+         --archived=(any|excluded|only)
+         --destination=$HOME/Documents
+         --gitlab-url=gitlab.example.com
+         --gitlab-token=<supersecrettoken>
+
+You can also set these environment variables:
+  GOGITLABBER_ARCHIVED=(any|excluded|only)
+  GOGITLABBER_DESTINATION=$HOME/Documents
+  GITLAB_API_TOKEN=<supersecrettoken>
+  GITLAB_URL=gitlab.example.com
+```