Throw down some docs in that README
This commit is contained in:
parent
c05a8e65dc
commit
2fb474c87c
25
README.md
25
README.md
@ -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
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user