diff --git a/README.md b/README.md index 730357d..07cface 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,33 @@ The app starts a local VPN that captures only DNS traffic and forwards every que - 📱 **Per-app DNS** — chosen apps bypass the tunnel - 🚫 **Custom blocklists** — your own domains plus hosts/domain/AdBlock lists by URL (HaGeZi Pro++ and TIF presets) - 🔓 **No analytics, no Google Play Services** + +## Installation + + + +1. Download the APK for the version you want from the [Releases page](https://github.com/kalarina-bit/Sparkledns/releases). +2. On your Android device, allow installs from unknown sources for the app you use to open the file (Settings → Apps → Special access → Install unknown apps). +3. Open the downloaded `.apk` file and confirm the install. + +## Verifying a download + + + +Compare the SHA-256 checksum of the downloaded APK against the value shown for that version on the [Releases page](https://github.com/kalarina-bit/Sparkledns/releases): + +```sh +sha256sum Sparkledns-vX.X.X.apk +``` + +## Repository structure + + + +``` +. +├── assets/ # Icon images +└── README.md +``` + +APK builds are published as assets on the [Releases page](https://github.com/kalarina-bit/Sparkledns/releases), not stored in this repository. diff --git a/assets/icon-install.png b/assets/icon-install.png new file mode 100644 index 0000000..4c55e5f Binary files /dev/null and b/assets/icon-install.png differ diff --git a/assets/icon-structure.png b/assets/icon-structure.png new file mode 100644 index 0000000..5573e2b Binary files /dev/null and b/assets/icon-structure.png differ diff --git a/assets/icon-verify.png b/assets/icon-verify.png new file mode 100644 index 0000000..079932a Binary files /dev/null and b/assets/icon-verify.png differ