Add readme file

This commit is contained in:
Niklas Meinzer
2024-12-18 22:25:37 +01:00
parent 85d38dfdf7
commit 848122de02

20
README.md Normal file
View File

@@ -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
```