From bab6c754dc5a896d27b619e9c78a98888fdb8cd4 Mon Sep 17 00:00:00 2001 From: kalarina Date: Fri, 16 Oct 2026 11:51:04 +0000 Subject: [PATCH] Redesign README: store badges, release badge, install options --- README.md | 59 ++++++++++++++++++++++++++----------------------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index bd45c87..82b2960 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@

- SparkleDNS icon + SparkleDNS icon

SparkleDNS

-

A lightweight DNS-over-HTTPS client for Android.

-

- Get it on Gitea + A lightweight DNS-over-HTTPS client for Android.
+ A local VPN that captures only DNS traffic and sends every query to the DoH server you choose (RFC 8484). Everything else goes through your normal connection.

- Android 8.0+ - GPL-3.0-or-later + Latest release

-SparkleDNS starts a local VPN that captures only DNS traffic and sends every query to the DoH server you choose (RFC 8484). Everything else goes through your normal connection. +

+ Get it on F-Droid + Get it on Obtainium + Get it on GitHub + Get it on Gitea +

-## Features +

+ Your DNS, your choice + Protected via SkySparkle + Stay informed + Block your way + Choose your own route +

+ +## ✨ Features - 🔌 **One-tap connect/disconnect**, with a Quick Settings tile - 🔄 **Switch servers on the fly** — the tunnel restarts automatically @@ -27,27 +38,13 @@ SparkleDNS starts a local VPN that captures only DNS traffic and sends every que - 🚫 **Custom blocklists** — your own domains plus hosts/domain/AdBlock lists by URL (HaGeZi Pro++ and TIF presets) - 🔓 **No analytics, no Google Play Services** -## Screenshots +## Installation -

- Your DNS, your choice - Protected via SkySparkle - Stay informed - Block your way - Choose your own route -

+- **[F-Droid](https://f-droid.org/packages/cc.skysparkle.sparkledns/)** — install and update through the F-Droid client. +- **[Obtainium](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://github.com/kalarina-bit/Sparkledns)** — installs the APK straight from GitHub releases and keeps it up to date. +- **Manually** — download the latest APK from [GitHub](https://github.com/kalarina-bit/Sparkledns/releases/latest) or [Gitea](https://git.skysparkle.cc/kalarina/Sparkledns/releases), allow installs from unknown sources for the app you open it with (Settings → Apps → Special access → Install unknown apps), then open the `.apk` and confirm. -## Installation - - - -1. Download the latest APK from the [Releases page](https://git.skysparkle.cc/kalarina/Sparkledns/releases). -2. Allow installs from unknown sources for the app you open it with (Settings → Apps → Special access → Install unknown apps). -3. Open the `.apk` file and confirm the install. - -## Verifying a download - - +## Verifying a download Every official APK is signed with the same key. Check it before installing: @@ -63,7 +60,7 @@ The SHA-256 fingerprint of the signing certificate must be: `apksigner` prints the same value in lowercase without colons. On Android you can check it with [AppVerifier](https://github.com/soupslurpr/AppVerifier) (app ID `cc.skysparkle.sparkledns`). -## Building from source +## Building from source Requires JDK 17+ and Android SDK 36. @@ -75,12 +72,12 @@ Requires JDK 17+ and Android SDK 36. 1. Bump `versionName` and `versionCode` in `app/build.gradle.kts` (`versionCode = major * 10000 + minor * 100 + patch`). 2. Add `fastlane/metadata/android//changelogs/.txt`. -3. Tag the commit as `v` (for example `v1.0.6`) — F-Droid detects new releases from these tags. +3. Tag the commit as `v` (for example `v1.0.9`) — F-Droid detects new releases from these tags, so upload the signed APK to the release right away. -## Contributing +## 🤝 Contributing Bug reports, DoH server and blocklist suggestions, translation fixes and pull requests are welcome in the [issue tracker](https://git.skysparkle.cc/kalarina/Sparkledns/issues). Please read [CONTRIBUTING.md](CONTRIBUTING.md) first — it explains what fits the project and how to send changes. To open an issue or a pull request, [create an account](https://git.skysparkle.cc/user/sign_up) on this Gitea. -## License +## 📄 License [GNU General Public License v3.0 or later](LICENSE).