Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daniellacosse committed Oct 2, 2024
1 parent 3bbf098 commit 0266f61
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions x/examples/outline-pwa/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 0266f61

Please sign in to comment.