From 2fb474c87cc284a9312fc93bfa0b4c17bcf0f155 Mon Sep 17 00:00:00 2001
From: decentral1se <hi@decentral1.se>
Date: Wed, 7 Apr 2021 16:42:45 +0200
Subject: [PATCH] Throw down some docs in that README

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

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
+```