Update README and fastlane description

Thanks to an anonymous contributor for suggestions
This commit is contained in:
xynngh 2020-05-11 00:12:29 +04:00
parent fc3986e057
commit b0435bee99
2 changed files with 27 additions and 23 deletions

View File

@ -3,26 +3,31 @@
# Yet Another Call Blocker
The goal of this project is to provide a free and open source application that can block unwanted calls or warn about probable intentions of the callers using a third-party crowdsourced phone number database (from some other proprietary app).
A free and open source application that can block unwanted calls or warn about probable intentions of callers using a third-party crowdsourced phone number database (from some other proprietary app).
## Key features
* Uses offline database.
* Blocks unwanted calls automatically (option).
* Displays a notification with phone number summary (rating, reviews count, category) during incoming calls (option).
* Performs incremental/delta database updates (option).
* You can view online reviews for caller's number (provided by 3rd party service).
## How to use
* Install and launch the app.
* At first start, the app will suggest to download main database. Simply confirm the download and wait for a few seconds.
The DB will be downloaded from [another gitlab repo](https://gitlab.com/xynngh/YetAnotherCallBlocker_data).
* The option to show notifications for incoming calls is enabled by default, so the app will ask for a phone-related permission.
Grant the permission if you want to be able to use most of the app's features.
* After that you should be able to see recent calls with some additional info on the main screen of the app.
The app will also display notifications with some caller info during incoming calls.
You can press such a notification to see more info or to load detailed online reviews.
* Check the "Auto-update database" checkbox in menu (recommended) to automatically receive daily DB updates (these are delta updates, so they consume very little traffic).
* Check the "Block unwanted calls" checkbox if you want to enable automatic call blocking.
* The option to show caller info notifications is enabled by default, so the app will ask for phone-related permissions.
* At first start, the app will suggest to download main database which is required for most of the functions. Simply confirm the download.
(The DB is downloaded from [another gitlab repo](https://gitlab.com/xynngh/YetAnotherCallBlocker_data), so no privacy-related implications.)
* Check the "Auto-update database" checkbox in the menu (recommended) to automatically receive daily DB updates (these are incremental/delta updates, so they consume very little traffic).
* Check the "Block unwanted calls" checkbox to block calls with negative rating automatically.
* You can also check the "Use contacts" checkbox if you want your contacts not to be treated as unknown callers.
* After these steps everything should just work. Enjoy!
## Features
## More on features
At this point most of the essential features (one would expect from a call blocking app) are implemented. Here's an overview:
@ -42,7 +47,7 @@ The only known possible data leaks are the following:
* Database update procedure leaks user's IP address to the update servers.
The request also includes current database version (base or updated).
* Online review requests leak user's IP address coupled with the phone number in question.
Shouldn't be a big deal unless you call it for a bunch of numbers in your phone book.
Shouldn't be a big deal unless you request it for numbers in your phone book.
If the "use contacts" feature is enabled, a confirmation dialog is shown if online reviews are requested for a number present in your phone book.
No other identifiable information is sent with the requests.

View File

@ -3,24 +3,23 @@ using an offline phone number database.
Features:
* Showing a notification with some caller info (positive/negative rating, category, number of negative reviews and such) when the phone's ringing. ''Works offline.''
* Loading and displaying a list of reviews for a number. ''Requires internet.''
* Automatic blocking of unwanted calls (may not work on some devices; tested to work on modern Android versions (including Android 10)). ''Works offline.''
* Automatic update of the database (for offline use). ''Requires internet.''
* Uses offline database.
* Blocks unwanted calls automatically (option).
* Displays a notification with phone number summary (rating, reviews count, category) during incoming calls (option).
* Performs incremental/delta database updates (option).
* You can view online reviews for caller's number (provided by 3rd party service).
How to use:
* Install and launch the app.
* At first start, the app will suggest to download main database. Simply confirm the download and wait for a few seconds.
* The option to show notifications for incoming calls is enabled by default, so the app will ask for a phone-related permission. Grant the permission if you want to be able to use most of the app's features.
* After that you should be able to see recent calls with some additional info on the main screen of the app. The app will also display notifications with some caller info during incoming calls. You can press such a notification to see more info or to load detailed online reviews.
* Check the "Auto-update database" checkbox in menu (recommended) to automatically receive daily DB updates (these are delta updates, so they consume very little traffic).
* Check the "Block unwanted calls" checkbox if you want to enable automatic call blocking.
* The option to show caller info notifications is enabled by default, so the app will ask for phone-related permissions.
* At first start, the app will suggest to download main database which is required for most of the functions. Simply confirm the download.
* Check the "Auto-update database" checkbox in the menu (recommended) to automatically receive daily DB updates (these are incremental/delta updates, so they consume very little traffic).
* Check the "Block unwanted calls" checkbox to block calls with negative rating automatically.
* You can also check the "Use contacts" checkbox if you want your contacts not to be treated as unknown callers.
* After these steps everything should just work. Enjoy!
The main phone number database is downloaded from
[https://gitlab.com/xynngh/YetAnotherCallBlocker_data a gitlab repository].
The main phone number database is downloaded from a gitlab repository.
Delta updates and detailed review queries are performed using 3rd-party servers.
No user-identifiable information is sent (except for the phone number
the detailed reviews are loaded for).