From 651b4e620a14c68c4cc5d4c836da6aa3135fac8c Mon Sep 17 00:00:00 2001
From: Yoran Brondsema <yoran@curvo.eu>
Date: Fri, 8 Nov 2019 11:50:35 +0100
Subject: [PATCH] Add README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aac8306
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# fastboot-gcloud-storage-notifier
+This is a notifier plugin for `fastboot-app-server`. It is to be used in conjunction with [fastboot-app-server](https://github.com/ember-fastboot/fastboot-app-server) and [fastboot-gcloud-storage-downloader](https://github.com/EmberSherpa/fastboot-gcloud-storage-downloader). See the [documentation on fastboot-app-server](https://github.com/ember-fastboot/fastboot-app-server#notifiers) to understand what the role of a notifier is.
+
+## Usage
+```javascript
+// fastboot-server/server.js
+
+const GCloudStorageNotifier = require('fastboot-gcloud-storage-notifier');
+
+let notifier = new GCloudStorageNotifier({
+  bucket: <bucket-where-assets-are>,
+  key: <path-to-manifest> // e.g. 'fastboot-deploy-info.json'
+});
+
+let server = new FastBootAppServer({
+  ...
+  notifier
+});
+
+...
+```