Add more info about this project into README

This commit is contained in:
JensDiemer 2020-12-29 10:54:06 +01:00
parent 41df6139c1
commit b61f33e745

View file

@ -10,10 +10,29 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
Pull requests welcome ;) Pull requests welcome ;)
## Overview ## Overview
Glue code to package django projects as yunohost apps. 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 ## SSO authentication
[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported: [SSOwat](https://github.com/YunoHost/SSOwat) is fully supported: