Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 29678581: Issue 6000 - Rename "libadblockplus-android" (Closed)
Patch Set: addressed comments Created Jan. 29, 2018, 11:04 a.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | adblock-android-settings/AndroidManifest.xml » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
diff --git a/README.md b/README.md
index 322abb1e9ca0864105b0db5ef02c45f4c6c7b6a0..1d0852541314c857a29c6c355df0e719c0adc24e 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-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
@@ -13,14 +13,14 @@ To update those, call:
## 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 24.0.1
+* Android SDK Build tools 25.0.0
* [The Android NDK, 12b](https://developer.android.com/ndk)
Edit 'buildToolsVersion' in 'build.gradle' files if necessary.
@@ -37,7 +37,7 @@ 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**
@@ -88,13 +88,13 @@ Note
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:
@@ -102,14 +102,14 @@ Pass `abi_arm` or `abi_x86` to build it for single arch or `abi_all` for all ARC
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
@@ -122,7 +122,7 @@ 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
@@ -132,7 +132,7 @@ 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
@@ -184,12 +184,12 @@ 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 'adblocks-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
@@ -230,12 +230,12 @@ 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
@@ -245,4 +245,4 @@ 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.
« no previous file with comments | « no previous file | adblock-android-settings/AndroidManifest.xml » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld