Throw down some docs in that README

This commit is contained in:
decentral1se 2021-04-07 16:42:45 +02:00
parent c05a8e65dc
commit 2fb474c87c
Signed by: decentral1se
GPG Key ID: 92DAD76BD9567B8A

View File

@ -1,3 +1,26 @@
# djangoldp-webpushnotification # djangoldp-webpushnotification
> WIP Enable [Web Push](https://developers.google.com/web/fundamentals/push-notifications) notifications.
## Install
```bash
$ python -m pip install 'djangoldp_webpushnotification'
```
Tnen add the app to your `settings.yml` like so:
```yaml
django:
- djangoldp_webpushnotification
```
## Management commands
- `gen_vapid_keys`: Generate VAPID key pair
## Test
```bash
$ python -m unittest djangoldp_webpushnotification.tests.runner
```