From b61f33e74588c38ad67858b63efa33653cbac857 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 29 Dec 2020 10:54:06 +0100 Subject: [PATCH] Add more info about this project into README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 5143946..55a0bee 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,29 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Pull requests welcome ;) + ## Overview Glue code to package django projects as yunohost apps. +This project is: + +* The Python package [django-ynh](https://pypi.org/project/django-ynh/) with helpers for integrate a Django project as YunoHost package +* A example YunoHost Application that can be installed +* Run Django development server with a local generated YunoHost package installation (called `local_test`) + + +### usage + +To create/update a the first user in `install`/`upgrade`, e.g.: + +```bash +./manage.py create_superuser --username="$admin" --email="$admin_mail" +``` +This Create/update Django superuser and set a unusable password. +A password is not needed, because auth done via SSOwat ;) + + ## SSO authentication [SSOwat](https://github.com/YunoHost/SSOwat) is fully supported: