From 9579ea57d09de8051d15189e832dcb815f9307f4 Mon Sep 17 00:00:00 2001
From: Glenn <glenux@glenux.net>
Date: Wed, 17 Aug 2022 18:56:02 +0200
Subject: [PATCH] Update documentation

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa28760
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Collect Repositories
+
+Find, list and filter git repositories on your system.
+
+Use cases: 
+* finding repositories without a remote repository defined
+* find repositories using a remote repository on X but not on Y (where X and Y can be Gitlab, Github, Bitbucket, Gitea, ...)
+* finding repositories that are not registered in mrconfig
+
+## Usage
+
+```shell-session
+$ collect-repos list -r . gitea=false,github=false,gitlab=false,bitbucket=false,mr=false
+SELECTOR: gitea=false AND github=false AND gitlab=false AND bitbucket=false AND mr=false
+
+PATH
+---------------------------------------------------
+dev--editor-vscodium
+dev--git-basics/examples/stories-project
+dev--git-basics/examples/stories-project2
+devops--build-and-dependencies
+devops--ci-and-cd/examples/webhook-server
+devops--docker-demo
+devops--kubernetes/exercises/exo2-nextcloud/tmp/k8s
+draft--devops--industrial
+framework--jekyll
+framework--nodejs/projets/page-authentification
+framework--nodejs-advanced
+pm--it-project/demos/wiki/wikidata
+pm--nepal
+```
+
+## Authors
+
+FIXME
+
+## Licence
+
+FIXME
+