Skip to content

Commit

Permalink
Improve README files
Browse files Browse the repository at this point in the history
  • Loading branch information
doubleangels committed Feb 18, 2025
1 parent 94b2fcf commit c69ead9
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 57 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Contributing

I welcome contributions to NextDNS Manager from the community. Whether it's bug fixes, new features, or improvements to documentation, your contributions make a significant difference.
I welcome contributions to NextDNS Manager. Whether it's bug fixes, new features, or improvements to documentation, your input helps make this project better.

## How Can You Contribute?

You can contribute to NextDNS Manager in various ways:
There are several ways you can contribute:

### Documentation

Improvements to the project's documentation are always welcome. You can suggest edits, updates, or new sections to make it more informative and user-friendly.
Improving the documentation is always valuable. You can suggest edits, propose updates, or add new sections to make the project more informative and user-friendly.

### Translations

If you notice inaccuracies in translations, please open an issue to report them or contribute to the [translation project](https://poeditor.com/join/project/EupqZ3cGCJ).
If you find any inaccuracies in translations, please open an issue to report them or contribute directly to the [translation project](https://poeditor.com/join/project/EupqZ3cGCJ).

### Code Contributions

For those interested in making code contributions, please open a pull request with your proposed changes. Automated tests must pass for your pull request to be merged
If you'd like to contribute code, please open a pull request with your changes. Make sure that all automated tests pass before submitting your pull request.
142 changes: 95 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
<!--suppress ALL -->
<p align="center">
<img src="https://img.shields.io/github/release/doubleangels/NextDNSManager.svg?logo=github&label=GitHub%20Build&style=for-the-badge" alt="GitHub Build">
<img src="https://img.shields.io/f-droid/v/com.doubleangels.nextdnsmanagement.svg?logo=F-Droid&label=F-Droid%20Build&style=for-the-badge" alt="F-Droid Build">
Expand All @@ -10,94 +9,143 @@
</p>

<p align="center">
<img src="icons/web/icon-192.png" alt="Icon">
<img src="icons/web/icon-192.png" alt="NextDNS Manager Icon" width="96">
<br>
<a href="https://play.google.com/store/apps/details?id=com.doubleangels.nextdnsmanagement">
<img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Google Play">
<img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Get it on Google Play" height="48">
</a>
<a href="https://f-droid.org/en/packages/com.doubleangels.nextdnsmanagement">
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="F-Droid">
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="48">
</a>
</p>

<p align="center">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" alt="Screenshot">
<p align="center">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" alt="Screenshot of NextDNS Manager" width="250">
</p>

# About
# NextDNS Manager

NextDNS Manager is an Android application that simplifies managing your [NextDNS](https://nextdns.io) configuration. NextDNS is a cloud-based DNS filter and firewall designed to protect your home, family, and online privacy. With NextDNS Manager, you can effortlessly control your NextDNS settings to ensure a safer and more secure digital experience.

**Compatible with any Android device running Android 12L or later.**

> **Note:** NextDNS Manager is a completely open-source project and is not officially affiliated with NextDNS.
---

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Which installation method should I use?](#which-installation-method-should-i-use)
- [Google Play Store](#google-play-store)
- [F-Droid Installation](#f-droid-installation)
- [Manual Installation](#manual-installation)
- [Reporting Issues & Feedback](#reporting-issues--feedback)
- [Contributing](#contributing)
- [Security Policy](#security-policy)
- [Privacy & Terms](#privacy--terms)
- [Donations](#donations)
- [License](#license)

---

NextDNS Manager is an Android application that simplifies the management of your [NextDNS](https://nextdns.io) configuration. NextDNS is a cloud-based DNS filter and firewall that protects your home, family, and privacy online. With NextDNS Manager, you can easily control your NextDNS settings and ensure a safer and more secure online experience.
## Features

NextDNS Manager can be installed on any Android phone or tablet running Android 12L+
- **Intuitive Interface:**
Enjoy a user-friendly experience enhanced with Material You styling, automatic dark mode, dynamic/themed icons, and support for 14 languages.

**NextDNS Manager is a completely open-source project with no official ties to NextDNS.**
- **Comprehensive Configuration Management:**
Easily manage your NextDNS settings including filtering modes, blocklists, and whitelists.

# Features:
- **Real-Time Statistics:**
Monitor DNS queries, blocked requests, and security events as they happen.

- **Intuitive Interface**: NextDNS Manager provides a user-friendly interface that allows you to manage your NextDNS settings with ease. The interface also includes Material You styling, automatic dark mode, as well as a dynamic/themed icon. The application also supports 14 languages!
- **Enhanced Security and Privacy:**
Benefit from NextDNS' robust filtering capabilities to safeguard your online activities.

- **Configuration Management**: You can configure your NextDNS settings, including filtering modes, blocklists, and whitelists.
- **Multiple Installation Options:**
Download and install NextDNS Manager via the Google Play Store, F-Droid, or directly from GitHub.

- **Real-time Statistics**: Get insights into your DNS queries, blocked requests, and security events in real-time.
---

- **Security and Privacy**: Enhance your online security and privacy by leveraging NextDNS' filtering capabilities.
## Installation

- **Easy Installation**: You can download and install NextDNS Manager from the Google Play Store, F-Droid, or directly from GitHub, providing multiple installation options.
### Which installation method should I use?

# Installation
Your choice depends on your privacy preferences and update frequency needs:

## Which installation method should I use?
- **Google Play Store:** Best for those who prefer automatic updates.
- **Manual APK Sideload:** Ideal if you cannot access Google Play.
- **F-Droid:** Suitable for users prioritizing open-source purity, though updates may take longer.

Which app you should use depends on your privacy preferences and how often you wish to receive updates:
> **Note:**
> - FCM notifications are removed in F-Droid builds.
> - Builds prior to version 5.5.0 do not support notifications.
- If you are able to use Google Play, use it.
- If you're not able to use Google Play, sideload an APK from this repository.
- If neither of these options work for you, install the app from F-Droid.
| Method | Availability |
|--------------------|----------------------|
| **Google Play** | A few minutes |
| **Sideloaded APK** | A few minutes |
| **F-Droid** | Up to 14 days |

Note: Notifications through FCM is removed in F-Droid builds. There is no notification support for any builds prior to 5.5.0.
*F-Droid builds take longer because each update is manually signed in a secure, air-gapped environment.*

For each build ("version") of the app, there are timelines for when the build will be available, so methods with longer timelines will result in longer wait times for updates.
### Google Play Store

| | Google Play | Sideloaded APK | F-Droid |
|------------------|---------------|----------------|---------------|
| **Availability** | A few minutes | A few minutes | Up to 14 days |
Download NextDNS Manager from the [Google Play Store](https://play.google.com/store/apps/details?id=com.doubleangels.nextdnsmanagement).

F-Droid takes much longer than any of the other methods because they have a human involved in the process, each app is signed by a human on a computer that is air-gapped (not connected to the internet).
### F-Droid Installation

## Google Play Store
Get NextDNS Manager on F-Droid from the [official page](https://f-droid.org/en/packages/com.doubleangels.nextdnsmanagement).

NextDNS Manager is available on the Google Play Store [here](https://play.google.com/store/apps/details?id=com.doubleangels.nextdnsmanagement).
### Manual Installation

## F-Droid Installation
Download the latest APK directly from the [GitHub Releases page](https://github.com/doubleangels/NextDNSManager/releases).

NextDNS Manager is available on F-Droid [here](https://f-droid.org/en/packages/com.doubleangels.nextdnsmanagement).
---

## Manual Installation
## Reporting Issues & Feedback

The most recent APK is available for download [here](https://github.com/doubleangels/NextDNSManager/releases).
If you encounter any issues or have suggestions to enhance NextDNS Manager, please take the following steps:

# Reporting Issues/Suggestions and Feedback
1. Check the [FAQ](FAQ.md) for common questions.
2. Open a new [GitHub Issue](https://github.com/doubleangels/NextDNSManager/issues/new/choose) with a detailed description.

If you encounter any issues while using NextDNS Manager, I encourage you to report them to me. Please read the [FAQ's](FAQ.md) and then open an [issue](https://github.com/doubleangels/NextDNSManager/issues/new/choose). Please note that I work on this project in my free time, so issue responses may be delayed.
Your suggestions and feedback are valuable to me as they help me improve NextDNS Manager. If you have any ideas for enhancements or feedback to share, please do so by opening a new issue as outlined above. Be sure to provide a detailed description of your suggestion or feedback.
*Please note that contributions and responses may take time as this project is maintained in my free time.*

# Contributing
---

Please learn how to contribute to this project [here](CONTRIBUTING.md).
## Contributing

# Security Policy
Interested in contributing? Please review the [Contributing Guidelines](CONTRIBUTING.md) to learn how you can help improve NextDNS Manager.

Learn about this application's security policy [here](SECURITY.md).
---

# Terms & Conditions/Privacy Policy
## Security Policy

Learn about my [Security Policy](SECURITY.md) for reporting vulnerabilities and keeping your data safe.

---

## Privacy & Terms

- [Privacy Policy](https://doubleangels.github.io/privacyPolicy/nextdns.html)
- [Terms and Conditions](https://doubleangels.github.io/privacyPolicy/nextdns_terms.html)

# Donations
---

## Donations

Donations are completely optional but always appreciated.
[Donate Here](https://donate.stripe.com/4gw8yhbvH0mg6SQ7ss)

---

## License

- Donations are always optional.
- [Donate Here](https://donate.stripe.com/4gw8yhbvH0mg6SQ7ss)
NextDNS Manager is released under the [GPLv3 License](LICENSE).

# License
---

NextDNS Manager is open-source and released under the [GPLv3](LICENSE).
I hope you enjoy using NextDNS Manager. Happy managing!
16 changes: 11 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

## Reporting a Vulnerability

I take security seriously. If you discover a vulnerability, I appreciate your help in disclosing it to me in a responsible manner. Please follow these guidelines when reporting security vulnerabilities:
I take security seriously, and I appreciate your assistance in responsibly disclosing any vulnerabilities. If you discover a security issue, please follow these guidelines when reporting it:

1. **Privately Disclose**: Please avoid publicly disclosing the vulnerability until I have had a chance to address it. Instead, report it to me privately. You can do this via email or by reporting a vulnerability in the issues section of this repository.
1. **Privately Disclose:**
Do not publicly disclose the vulnerability until I have had a chance to address it. Instead, report it privately via email or by opening a confidential issue in the repository.

2. **Provide Details**: When reporting a vulnerability, please provide me with sufficient details to understand and reproduce the issue. Include information such as the device you're running the app on, the version of Android you're using, the version of the app you're using, and a detailed description of the vulnerability.
2. **Provide Sufficient Details:**
Include all relevant information needed to understand and reproduce the issue. This should include details such as:
- The device and Android version you are using.
- The version of NextDNS Manager.
- A detailed description of the vulnerability.

3. **Responsible Disclosure**: Allow me a reasonable amount of time to address the vulnerability before disclosing it publicly.
3. **Responsible Disclosure:**
Allow a reasonable period for me to fix the vulnerability before any public disclosure.

We appreciate your efforts in helping me maintain the security of NextDNS Manager. Thank you for your cooperation.
Thank you for helping me maintain the security of NextDNS Manager.

0 comments on commit c69ead9

Please sign in to comment.