Issue 6000 - Rename "libadblockplus-android"

README.md

-Adblock Plus Library for Android
+Adblock Android SDK
 ================================
 
-An Android library project, tests and demo application for AdblockWebView widget.
+An Android library project, tests, settings fragments and demo application for AdblockWebView.
 
 ## Updating the dependencies
 
-Adblock Plus for Android has dependencies that aren't in this repository.
+Adblock Android SDK has dependencies that aren't in this repository.
 To update those, call:
 
     ./ensure_dependencies.py
 
 ## Library
 
 An Android library that provides the core functionality of Adblock Plus.
-You can find it in the 'libadblockplus-android' directory.
+You can find it in the 'adblock-android' directory.
 
 ### Building
 
 #### Requirements
 
 * [The Android SDK](https://developer.android.com/sdk)
 * Android SDK Build tools 25.0.0
 * [The Android NDK, 16b](https://developer.android.com/ndk)
 
 Edit 'buildToolsVersion' in 'build.gradle' files if necessary.
 
 #### Building from command-line
 
 In the project root directory create the file _local.properties_ and set
 _sdk.dir_ and _ndk.dir_ to where you installed it, e.g.:
 
     sdk.dir = /some/where/sdk
     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.
+This will generate *.aar library artifact in the 'adblock-android/build/outputs/aar/' directory.
 
 **Android permissions note**
 
 An app that uses the library have to add the following permissions to `AndroidManifest.xml`:
  * `<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>`
  * `<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>`
 
 (added automatically if building with Gradle or should be added manually otherwise).
 
 ### Build directory configuration
@@ skipping 30 matching lines @@
 Note
   
     [Configuration] Excluding shared v8 library libv8.cr.so from AAR
     ...
     [Configuration] Linking dynamically with shared v8 library ./libadblockplus-binaries/android_armeabi-v7a/libv8.cr.so
     ...
 
 output while building.
 
 Set `SHARED_V8_LIB_DIR` environment variable as full absolute path to pass
-specific directory instead of default one (`libadblockplus-android/jni/libadblockplus-binaries`).
+specific directory instead of default one (`adblock-android/jni/libadblockplus-binaries`).
 
 ### Building for single ARCH
 
-By default libadblockplus-android is built for both ARM and x86 and it can be filtered when
+By default adblock-android is built for both ARM and x86 and it can be filtered when
 building end-user android application. However sometimes it can be desired to build
-"libadblockplus-android.aar" for single ARCH.
+"adblock-android.aar" for single ARCH.
 
 Pass `abi_arm` or `abi_x86` to build it for single arch or `abi_all` for all ARCHs:
 
     `./gradlew clean assembleAbi_arm`
     
 Note
 
-    [Configuration] Using libadblockplus-android ABI flavor: abi_arm
+    [Configuration] Using adblock-android ABI flavor: abi_arm
     
 output while building.
 
 ## Library tests
 
 Android tests for the library.
-You can find them in the 'libadblockplus-android-tests' directory.
+You can find them in the 'adblock-android-tests' directory.
 
 ### Requirements
 
 Make sure _Library_ requirements are present.
 
 ### Building
 
 Make sure you've created the _local.properties_ file to build the library (see above).
 In the project root directory run:
 
     ./gradlew assembleDebugAndroidTest
 
-This will generate *.apk in the 'libadblockplus-android-tests/build/outputs/apk/' directory.
+This will generate *.apk in the 'adblock-android-tests/build/outputs/apk/' directory.
 
 ### Testing
 
 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 that provides a configuration interface for Adblock Plus.
-You can find it in the 'libadblockplus-android-settings' directory:
+You can find it in the 'adblock-android-settings' directory:
 * GeneralSettingsFragment - main fragment
 * WhitelistedDomainsSettingsFragment - whitelisted domains fragment
 
 ### Usage
 
 Create `AdblockEngineProvider` instance and `AdblockSettingsStorage` instance.
 You can use `SharedPrefsStorage` implementation to store settings in `SharedPreferences`.
 Or you can use AdblockHelper:
 
     AdblockHelper
@@ skipping 54 matching lines @@
     AdblockHelper.get().getProvider().release();
 
 Insert `GeneralSettingsFragment` fragment instance in runtime to start showing settings UI.
 
 ### Building
 
 In the project root directory run:
 
     ./gradlew assemble
 
-This will generate *.aar in the 'libadblockplus-android-settings/build/outputs/aar' directory.
+This will generate *.aar in the 'adblock-android-settings/build/outputs/aar' directory.
 
 ## WebView
 
 An Android library that provides a WebView component with Adblock Plus integrated.
-You can find it in the 'libadblockplus-android-webview' directory.
+You can find it in the 'adblock-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 20 matching lines @@
 
 Use `dispose(Runnable disposeFinished)` to release resources (**required**).
 Note it can be invoked from background thread.
 
 ### Building
 
 In the project root directory run:
 
     ./gradlew assemble
 
-This will generate *.aar in the 'libadblockplus-android-webview/build/outputs/aar' directory.
+This will generate *.aar in the 'adblock-android-webview/build/outputs/aar' directory.
 
 ## WebView Application
 
 An Android application that demonstrates how to use AdblockWebView.
-You can find it in the 'libadblockplus-android-webviewapp' directory.
+You can find it in the 'adblock-android-webviewapp' directory.
 
 ### Building
 
 Make sure _Library_ requirements are present.
 
 In the project root directory run:
 
     ./gradlew assemble
 
-This will generate *.apk in the 'libadblockplus-android-webviewapp/build/outputs/apk/' directory.
+This will generate *.apk in the 'adblock-android-webviewapp/build/outputs/apk/' directory.