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

Unified Diff: README.md

Issue 29348393: Issue 4259 - Change libadblockplus-android description in README (Closed)
Patch Set: Added a brief description for all the modules. Removed duplicated section. Created Feb. 6, 2017, 6:37 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 | no next file » | 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 345956236ae16c0e3d6c24197822c9a89ab15784..7c4a198268c84c2f0382d72294f5900402f9530e 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
-Adblock Plus Library for Android
+Adblock Plus for Android
========================
An Android library project, tests and demo application for AdblockWebView widget.
## Updating the dependencies
-Adblock Plus Library for Android has dependencies that aren't in this repository.
+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
+in Java/Android. You can find adblock library in the 'libadblockplus-android' directory.
+
### Building with Ant
#### Requirements
@@ -82,6 +85,9 @@ This will generate *.aar library artifact in the 'libadblockplus-android/build/o
## Library tests
+An Android tests for the Library.
diegocarloslima 2017/02/06 20:35:33 The indefinite article 'An' can only be used for a
anton 2017/02/07 05:29:53 Acknowledged.
+You can find adblock library tests in the 'libadblockplus-android-tests' directory.
+
### Requirements
Make sure _Library_ requirements are present.
@@ -139,6 +145,7 @@ compiled, installed to emulator/device and launched automatically.
## Settings
+An Android library for the settings UI.
You can find adblock fragments in the 'libadblockplus-android-settings' directory:
* GeneralSettingsFragment - main fragment
* WhitelistedDomainsSettingsFragment - whitelisted domains fragment
@@ -202,39 +209,9 @@ In the project root directory run:
This will generate *.aar in the 'libadblockplus-android-settings/build/outputs/aar' directory.
-## WebView Application
-
-You can find demo application for 'AdblockWebView' class in
-'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.
-
-
## WebView
+An Android library for WebView UI with Adblock Plus integrated.
You can find 'AdblockWebView' class in the 'libadblockplus-android-webview' directory.
`AdblockWebView` class provides built-in ad blocking
@@ -290,6 +267,7 @@ This will generate *.aar in the 'libadblockplus-android-webview/build/outputs/aa
## WebView Application
+An Android application with AdblockWebView usage example.
You can find demo application for 'AdblockWebView' class in the
'libadblockplus-android-webviewapp' directory.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld