From 848122de029d61e4fffa4884c099c3fe838a1598 Mon Sep 17 00:00:00 2001
From: Niklas Meinzer <github@niklas-meinzer.de>
Date: Wed, 18 Dec 2024 22:25:37 +0100
Subject: [PATCH] Add readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..16d6811
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+This script creates Yunohost users in batch.
+
+Provided a csv file with user names and email adresses this script will create a yunohost user for each entry in the file and send an email with the credentials to the user.
+
+This script has no third party dependencies. 
+
+```
+usage: main.py [-h] [--dry-run] filename mail_user mail_password
+
+Creates Yunohost user from a csv file and sends them an email with the password
+
+positional arguments:
+  filename       Input file name
+  mail_user      This user will be used to send the confirmation mail
+  mail_password  This password will be used to send the confirmation mail
+
+options:
+  -h, --help     show this help message and exit
+  --dry-run
+```
\ No newline at end of file