mirror
/
NetGuard
mirror of https://github.com/M66B/NetGuard.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improvements to README.MD 

At Marcel's request :-)
This commit is contained in:
Gitoffthelawn 2015-10-26 03:12:35 -07:00
parent 7ce6ce9aed
commit 0e3c92c3a4
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,6 +1,6 @@
# NetGuard
NetGuard is possibly the first free and open source no root firewall for Android.
NetGuard is possibly the first free and open source no-root firewall for Android.
<img src="screenshot.png" width="232" height="371" hspace="4"/>
@ -9,28 +9,29 @@ Features
* No root required
* Simple to use
* Free and open source
* Free of charge
* Open source
* No extra battery usage
* No calling home
* No tracking (analytics)
* No tracking or analytics
* No ads
NetGuard doesn't even require internet permission.
NetGuard doesn't even require the *internet* permission!
Usage
-----
* Enable the firewall using the switch in the action bar
* Allow/deny Wi-FI/mobile internet access using the icons at the right side of the application list
* Allow/deny WiFi/mobile internet access using the icons at the right side of the application list
Permissions
-----------
* ACCESS_NETWORK_STATE: to check if the device is connected to the internet through Wi-Fi
* ACCESS_NETWORK_STATE: to check if the device is connected to the internet through WiFi
* RECEIVE_BOOT_COMPLETED: to start the firewall when starting the device
Frequently asked questions
--------------------------
Frequently Asked Questions (FAQ)
--------------------------------
<a name="FAQ1"></a>
**(1) Can NetGuard completely protect my privacy?**
@ -40,9 +41,9 @@ NetGuard will do its best, but it is limited by the fact it must use the VPN ser
This is the trade-off required to make a firewall which does not require root access.
Since the firewall must momentarily be turned off to update rules, and it only starts when Android "allows" it to start,
it will not offer 100% protection against an application connecting to the internet.
It will, however, be a lot better than nothing, especially if you are not rebooting often.
It will, however, be much better than nothing, especially if you are not rebooting often.
If you wanted to protect yourself more, you could (in theory at least) disable WiFi and mobile data before rebooting,
If you want to protect yourself more, you can (at least in theory) disable WiFi and mobile data before rebooting,
and only enable them on reboot, after the firewall service has started (and the small key icon is visible in the status bar).
Thanks @[pulser](https://github.com/pulser/)
@ -51,13 +52,13 @@ Thanks @[pulser](https://github.com/pulser/)
**(2) Can I use VPN applications while using NetGuard?**
If the VPN application is using the [VPN service](http://developer.android.com/reference/android/net/VpnService.html),
then no, because NetGuard needs to use this service too and Android allows this to just one application at a time.
then no, because NetGuard needs to use this service, and Android allows only one application at a time to use this service.
<a name="FAQ3"></a>
**(3) Can I use NetGuard on any Android version?**
No, because the method [addDisallowedApplication](http://developer.android.com/reference/android/net/VpnService.Builder.html#addDisallowedApplication(java.lang.String))
is being used the minimum required Android version is 5.0 (Lollipop).
is being used, the minimum required Android version is 5.0 (Lollipop).
<a name="FAQ4"></a>
**(4) Will NetGuard use extra battery power?**
@ -68,8 +69,8 @@ No, unlike most of the similar closed source alternatives.
Support
-------
* Questions: please [use this forum](http://forum.xda-developers.com/showthread.php?t=3233012)
* Feature requests and bugs: please [report an issue](https://github.com/M66B/NetGuard/issues/new)
* Questions: please [use this XDA-Developers forum thread](http://forum.xda-developers.com/showthread.php?t=3233012)
* Feature requests and bugs: please [report an issue on GitHub](https://github.com/M66B/NetGuard/issues/new)
Please do not use GitHub for questions.
@ -82,7 +83,7 @@ Translations:
* Check if the language [is supported by Android](http://stackoverflow.com/questions/7973023/what-is-the-list-of-supported-languages-locales-on-android) and find its locale
* Copy [this file](https://github.com/M66B/NetGuard/blob/master/app/src/main/res/values/strings.xml) to the correct locale folder
* Translate the strings in the copied file and omit all lines with **translatable="false"**
* Create a [pull request](https://help.github.com/articles/using-pull-requests) for the new/updated translation
* Create a [pull request on GitHub](https://help.github.com/articles/using-pull-requests) for the new/updated translation
Please note that you agree to the license below by contributing, including the copyright.