README.md - Issue 29336753: Issue 3671 - Split out contentBlockerList API

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Unified Diff: README.md

Issue 29336753: Issue 3671 - Split out contentBlockerList API (Closed)

Patch Set: Created Feb. 20, 2016, 9:59 p.m.

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Index: README.md

diff --git a/README.md b/README.md

index a5992562916a20dfcf9a9fb29cde27edda86912a..ba2c27ab41751bd09951cde0cdce06521654d298 100644

--- a/README.md

+++ b/README.md

@@ -10,16 +10,26 @@ Plus for other browsers are expected.

This script is used to convert the filter lists for

[Adblock Plus for iOS](https://adblockplus.org/releases/adblock-plus-10-for-ios-released).

-## Requirements

-The required packages can be installed via [NPM](https://npmjs.org):

+## Usage

```

-npm install

+node abp2blocklist.js < easylist.txt > easylist.json

```

-## Usage

+## Requirements

+The `node_modules` directory contains the required Adblock Plus modules, already

+converted to compatible JavaScript using JS Hydra. If for some reason you need

+to re-generate these files you can do so by running the following commands from

+the `adblockpluschrome` directory (assuming your abp2blocklist path is the same):

```

-node abp2blocklist.js < easylist.txt > easylist.json

+python buildtools/jshydra/abp_rewrite.py lib/punycode.js > ../abp2blocklist/adblockplus/punycode

+python buildtools/jshydra/abp_rewrite.py lib/publicSuffixList.js lib/url.js > ../abp2blocklist/adblockplus/url.js

+python buildtools/jshydra/abp_rewrite.py adblockpluscore/lib/filterNotifier.js > ../abp2blocklist/adblockplus

+python buildtools/jshydra/abp_rewrite.py adblockpluscore/lib/filterNotifier.js > ../abp2blocklist/adblockplus/filterNotifier.js

+python buildtools/jshydra/abp_rewrite.py adblockpluscore/lib/filterClasses.js > ../abp2blocklist/adblockplus/filterClasses.js

+python buildtools/jshydra/abp_rewrite.py lib/utils.js > ../abp2blocklist/node_modules/utils.js

```