diff --git a/README.md b/README.md index f09998a..b132f0b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # 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 +```