feat: updated repository documentation

Merge pull request #8 from vickywane/update/docs
ambianic · Mar 7, 2021 · 0de83a1 · 0de83a1
2 parents 7317bfb + 599d4f3
commit 0de83a1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/README.md b/README.md
@@ -1,7 +1,10 @@
-# ambianic-subscriptions
-Repo for ambianic premium subscription management
+# Ambianic-subscriptions
+## Repo for ambianic premium subscription management
 
-This repo hosts [Netlify functions](https://www.netlify.com/products/functions/) that handle Ambianic premium user subscriptions. This is code that cannot run in the browser PWA, because it needs access keys to subscription and payment gateway services (Stripe) shared between all app users. If the code runs in the PWA, users will be able to see and manipulate each other's premium subscription data
+<p> This repo hosts [Netlify functions](https://www.netlify.com/products/functions/) that handle Ambianic premium user subscriptions. This is code that cannot run in the browser PWA, because it needs access keys to subscription and payment gateway services (Stripe) shared between all app users. If the code runs in the PWA, users will be able to see and manipulate each other's premium subscription data </p>
+
+
+The image below shows the architecture of these serverless functions in connection with the Ambianic [PWA](https://github.com/ambianic/ambianic-ui/).
+![serverless-functions-architecture](./assets/serverless-architecture.png)
 
-A high level prototype of how these functions make up the ambianic serverless feature can be found [here](https://drive.google.com/file/d/181etJhBye0u1zvqzAnBY0VtCS0A3SlQ-/view?usp=sharing).
 
diff --git a/assets/serverless-architecture.png b/assets/serverless-architecture.png