From 0266f613d256d31e5da516e46bf487d61d7e2842 Mon Sep 17 00:00:00 2001
From: Daniel LaCosse <3759828+daniellacosse@users.noreply.github.com>
Date: Wed, 2 Oct 2024 16:33:12 -0400
Subject: [PATCH] update readme

---
 x/examples/outline-pwa/README.md | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/x/examples/outline-pwa/README.md b/x/examples/outline-pwa/README.md
index b371d1da..5541f6fc 100644
--- a/x/examples/outline-pwa/README.md
+++ b/x/examples/outline-pwa/README.md
@@ -1,7 +1,22 @@
-## Outline SDK PWA Example
+# Outline PWA
 
-TODO: Add description
+> [!CAUTION]
+> This is currently a WIP placeholder for the `outline-pwa` project. It has no actual logic in it yet.
 
-```bash
-npm run setup
+`outline-pwa` will be an sdk example project dedicated to demonstrating how one can use CapacitorJS to wrap an existing website to make it censorship resistant. To load the site you want to test into the project, cd into this directory and run the following command:
+
+```sh
+npm run setup https://www.bbc.com/persian
 ```
+
+This will update the ios and android subprojects with that site's index.html. You will then be able to open those projects in Xcode and Android Studio to see how effectively the entire site loads.
+
+## Strategies
+
+### iOS
+
+TODO
+
+### Android
+
+TODO
\ No newline at end of file