diff --git a/README.md b/README.md index 40b5e2d..4567be2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@
-SUP Icon +SUP Icon # SUP -**SUP (Signal Unified Push) is a privacy-preserving push notification system using Signal as transport** +**Privacy-preserving push notification system using Signal as transport** [Setup](#setup) • [Real-World Examples](#real-world-examples) • [Architecture](#architecture) @@ -34,6 +34,8 @@ For the optional Proton Mail integration, SUP requires a server that runs Proton ### 1. Install Android App (Optional) +> ⚠️ **Early Alpha**: The Android app is currently unavailable, but is planned for the full release of SUP. + An Android app is optionally available to connect UnifiedPush Android apps to the SUP server. It can also provide a better experience for displaying SUP-based notifications if the `ENABLE_ANDROID_INTEGRATION` environment variable is enabled on the server. Download the latest APK from [GitHub Releases](https://github.com/lone-cloud/sup/releases). @@ -46,6 +48,8 @@ Download the latest APK from [GitHub Releases](https://github.com/lone-cloud/sup ### 2. Proton Mail Integration (Optional) +> ⚠️ **Early Alpha**: Currently only `docker-compose.dev.yml` dev deployments are available. + A Proton Mail Bridge is optionally available if you want to receive push notifications for incoming emails. > **Note:** The default Proton Mail Bridge image uses `shenxn/protonmail-bridge:build` which compiles from source and supports multiple architectures. For x86_64 systems, you can use `shenxn/protonmail-bridge:latest` (pre-built binary, smaller and faster). For ARM devices (Raspberry Pi), stick with `:build`. @@ -94,6 +98,8 @@ Note that the bridge will first need to sync all of your old emails before you c ### 3. Install SUP Server +> ⚠️ **Early Alpha**: Currently only `docker-compose.dev.yml` dev deployments are available. + ```bash # Download docker-compose.yml curl -L -O https://raw.githubusercontent.com/lone-cloud/sup/master/docker-compose.yml @@ -168,7 +174,7 @@ docker compose -f docker-compose.dev.yml up protonmail-bridge Receive instant Signal notifications when new emails arrive in your Proton Mail inbox. -SUP monitors your Proton Mail account via the local Proton Mail Bridge and forwards email alerts through Signal. This relies on the same technology that a third party email client like Thunderbird would be using to integrate with Proton Mail. +SUP monitors your Proton Mail account via the local Proton Mail Bridge and forwards email alerts through Signal. This relies on the same technology that a third-party email client like Thunderbird would be using to integrate with Proton Mail. ### Home Assistant Alerts diff --git a/assets/screenshots/1.webp b/assets/screenshots/1.webp index 18287eb..4052922 100644 Binary files a/assets/screenshots/1.webp and b/assets/screenshots/1.webp differ diff --git a/assets/screenshots/2.webp b/assets/screenshots/2.webp index 04ad05e..6908e67 100644 Binary files a/assets/screenshots/2.webp and b/assets/screenshots/2.webp differ diff --git a/assets/screenshots/3.webp b/assets/screenshots/3.webp index ae5f67a..df8730d 100644 Binary files a/assets/screenshots/3.webp and b/assets/screenshots/3.webp differ diff --git a/assets/screenshots/4.webp b/assets/screenshots/4.webp index cf3474c..690a311 100644 Binary files a/assets/screenshots/4.webp and b/assets/screenshots/4.webp differ