diff --git a/README.md b/README.md index a8c97eb..57ac435 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/karasevm/PrivateDNSAndroid/total)](https://github.com/karasevm/PrivateDNSAndroid/releases/latest) [![GitHub Release](https://img.shields.io/github/v/release/karasevm/PrivateDNSAndroid)](https://github.com/karasevm/PrivateDNSAndroid/releases/latest) [![IzzyOnDroid](https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/ru.karasevm.privatednstoggle&label=IzzyOnDroid)](https://apt.izzysoft.de/fdroid/index/apk/ru.karasevm.privatednstoggle) +[![Translation status](https://hosted.weblate.org/widget/privatednsandroid/private-dns-quick-toggle/svg-badge.svg)](https://hosted.weblate.org/engage/privatednsandroid/) # Private DNS Quick Toggle A quick settings tile to switch your private dns provider. Supports any number of providers. Makes it easy to turn adblocking dns servers on or off with just @@ -12,11 +13,11 @@ a single tap. Get the latest apk on the [releases page](https://github.com/karasevm/PrivateDNSAndroid/releases/latest) or from [IzzyOnDroid repo](https://apt.izzysoft.de/fdroid/index/apk/ru.karasevm.privatednstoggle). -## Automatic (Shizuku) +### Automatic (Shizuku) 1. Install and start [Shizuku](https://shizuku.rikka.app/). 2. Start the app and allow Shizuku access when prompted. -## Manual +### Manual For the app to work properly you'll need to provide it permissions via ADB: 1. Get to your PC and download platform tools from google [here](https://developer.android.com/studio/releases/platform-tools). @@ -31,3 +32,18 @@ For the app to work properly you'll need to provide it permissions via ADB: 6. That's it, you should have the app installed. +## Contributing + +### Translation +The easiest way to contribute would be to submit a translation to your language. Thanks to Weblate gratis hosting for open-source projects you can do it without any programming knowledge on [their website](https://hosted.weblate.org/engage/privatednsandroid/). +#### Translation status + +Translation status + + +### Code +If you want to contribute code please try to adhere to the following guidelines: +- Include javadoc comments for all the public methods you add +- Keep the code neatly formatted, you can you the built-in Android Studio formatter +- Please describe what your code does and how does it do that when sending a PR +- Before sending a PR please test your change on the oldest and latest supported Android versions (9 and 14 at the time of writing)