From 59c48c68cb1ea5ed8d753509481d4844ab5b76e6 Mon Sep 17 00:00:00 2001
From: Harjot Singh <harjot@harkul.com>
Date: Sun, 10 Jul 2022 23:51:19 +0100
Subject: [PATCH] docs: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fa86113
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Shabad OS Content API
+
+This is a PoC, featuring:
+
+- Azure Functions
+- Cloudflare Edge
+- Azure Blob Storage
+- Azure CDN
+- GurbaniNow API
+
+Wired up, in an assortment of ways.
+
+```mermaid
+graph LR
+GN[GurbaniNow]
+Function[Azure Function]
+CF[Cloudflare Edge]
+Blob[Azure Blob Storage]
+CDN[Azure CDN]
+
+Function --> GN
+CF --> Function
+CF --> Blob
+CF --> CDN
+CF --> GN
+CDN --> Blob
+
+Entry -.-> Blob
+Entry -.-> Function
+Entry -.-> CDN
+Entry -.-> CF
+```
+
+## Setup & Running
+
+To work with the repo, install dependencies with `npm i`.
+
+Start the Azure Functions with `npm start`, locally. To spin up any Cloudflare edge workers, `cd` into the desired edge folder (`shabad-edge`) and run `npx wrangler dev -l` for a local instance.
+
+## Deployment
+
+The majority of this setup is built with Pulumi as IaaC in TypeScript. After installing pulumi, running `pulumi up` with an appropriately configured Azure account will deploy any stack changes.
+
+Unfortunately, the Cloudflare Worker provider in Pulumi does not support Cloudflare Worker modules with ES6 imports, therefore, these were manually uploaded with `npx wrangler publish`. An attempt at writing a custom REST provider for this use-case can be seen.