Issue 4259 - Change libadblockplus-android description in README

README.md

-Adblock Plus for Android

[Felix Dahlke, 2017/02/09 14:31:44]

That's a bit confusing since we have a product called "Adblock Plus for
Android", hm? I think "Adblock Plus Library for Android" is fine, since it's an
Android library project. If you don't like that, how about "Libadblockplus for
Android"?

[anton, 2017/02/10 10:24:37]

Acknowledged.

+Adblock Plus Library for Android
 ========================

[Felix Dahlke, 2017/02/23 12:53:59]

Nit: Please prolong this to match the title above.

 
 An Android library project, tests and demo application for AdblockWebView widget.
 
 ## Updating the dependencies
 
 Adblock Plus for Android has dependencies that aren't in this repository.
 To update those, call:
 
     ./ensure_dependencies.py
 
 ## Library
 
-An Android library that provides an opportunity to use Adblock Plus core functionality

[Felix Dahlke, 2017/02/09 14:31:44]

Seems we could shorten this a bit:

"An Android library that provides the core functionality of Adblock Plus. You
can find it in the 'libadblockplus-android' directory."

[anton, 2017/02/10 10:24:37]

Acknowledged.

-in Java/Android. You can find adblock library in the 'libadblockplus-android' directory.
+An Android library that provides the core functionality of Adblock Plus.
+You can find it in the 'libadblockplus-android' directory.
 
 ### Building with Ant
 
 #### Requirements
 
 * [The Android SDK](http://developer.android.com/sdk)
 * [The Android NDK](https://developer.android.com/tools/sdk/ndk)
 * [Ant](http://ant.apache.org)
 
 #### Building
@@ skipping 51 matching lines @@
     ndk.dir = /some/where/ndk
 
 In the project root directory run:
 
     ./gradlew assembleDebug
 
 This will generate *.aar library artifact in the 'libadblockplus-android/build/outputs/aar/' directory.
 
 ## Library tests
 
-Android tests for the Library.

[Felix Dahlke, 2017/02/09 14:31:44]

Same here:

"Android tests for the library. You can find them in the
'libadblockplus-android-tests' directory."

[anton, 2017/02/10 10:24:37]

Acknowledged.

-You can find adblock library tests in the 'libadblockplus-android-tests' directory.
+Android tests for the library.
+You can find them in the 'libadblockplus-android-tests' directory.
 
 ### Requirements
 
 Make sure _Library_ requirements are present.
 
 ### Building with Ant
 
 Set ANDROID_HOME environment variable to your Android SDK directory.
 
 In the 'libadblockplus-android-tests' directory run:
@@ skipping 38 matching lines @@
 
 This will generate *.apk in the 'libadblockplus-android-tests/build/outputs/apk/' directory.
 
 ### Testing with Gradle/Android Studio
 
 You can select test class/method and click 'Run ..Test'. The library and test app will be
 compiled, installed to emulator/device and launched automatically.
 
 ## Settings
 
-An Android library for the settings UI.

[Felix Dahlke, 2017/02/09 14:31:44]

This one I'd stretch a bit :D Maybe:

"An Android library that provides a configuration interface for Adblock Plus."

[anton, 2017/02/10 10:24:37]

Acknowledged.

-You can find adblock fragments in the 'libadblockplus-android-settings' directory:
+An Android library that provides a configuration interface for Adblock Plus.
+You can find it in the 'libadblockplus-android-settings' directory:
 * GeneralSettingsFragment - main fragment
 * WhitelistedDomainsSettingsFragment - whitelisted domains fragment
 
 ### Usage
 
 Create `AdblockEngine` instance with factory methods and `AdblockSettingsStorage` instance.
 You can use `SharedPrefsStorage` implementation to store settings in `SharedPreferences`.
 Or you can use AdblockHelper:
 
     AdblockHelper.get().init(this, true, AdblockHelper.PREFERENCE_NAME);
@@ skipping 44 matching lines @@
 #### Building with Gradle
 
 In the project root directory run:
 
     ./gradlew assemble
 
 This will generate *.aar in the 'libadblockplus-android-settings/build/outputs/aar' directory.
 
 ## WebView
 
-An Android library for WebView UI with Adblock Plus integrated.

[Felix Dahlke, 2017/02/09 14:31:44]

Maybe:

"An Android library that provides a WebView component with Adblock Plus
integrated."

Or something in that vein? Not sure if "component" is the right word here. Maybe
"WebView subclass" or something?

[anton, 2017/02/10 10:24:37]

Acknowledged.

-You can find 'AdblockWebView' class in the 'libadblockplus-android-webview' directory.
+An Android library that provides a WebView component with Adblock Plus integrated.
+You can find it in the 'libadblockplus-android-webview' directory.
 
 `AdblockWebView` class provides built-in ad blocking
 (both resource loading filtering and element hiding) and inherits from Android
 ['WebView'](https://developer.android.com/reference/android/webkit/WebView.html).
 
 ### Usage
 
 In layout XML:
 
     <org.adblockplus.libadblockplus.android.webview.AdblockWebView
@@ skipping 34 matching lines @@
 #### Building with Gradle
 
 In the project root directory run:
 
     ./gradlew assemble
 
 This will generate *.aar in the 'libadblockplus-android-webview/build/outputs/aar' directory.
 
 ## WebView Application
 
-An Android application with AdblockWebView usage example.

[Felix Dahlke, 2017/02/09 14:31:44]

"An Android application that demonstrates how to use AdblockWebView"?

[anton, 2017/02/10 10:24:37]

Acknowledged.

-You can find demo application for 'AdblockWebView' class in the
-'libadblockplus-android-webviewapp' directory.
+An Android application that demonstrates how to use AdblockWebView.
+You can find it in the 'libadblockplus-android-webviewapp' directory.
 
 ### Building
 
 Make sure _Library_ requirements are present.
 
 #### Building with Ant
 
 In the 'libadblockplus-android-webviewapp' directory create the file _local.properties_ and set
 _sdk.dir_ to where you installed it, e.g.:
 
     sdk.dir = /some/where/sdk
 
 Then run:
 
     ant debug
 
 This will generate *.apk in the 'libadblockplus-android-webviewapp/bin/' directory.
 
 #### Building with Gradle
 
 In the project root directory run:
 
     ./gradlew assemble
 
 This will generate *.apk in the 'libadblockplus-android-webviewapp/build/outputs/apk/' directory.