Unified Diff: README.md
Issue 29336753:
Issue 3671 - Split out contentBlockerList API (Closed)
Patch Set: Reworked API into ContentBlockerList class and addressed other feedback
Created Feb. 22, 2016, 12:21 p.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« .hgignore ('k')
|
abp2blocklist.js » ('j')
|
lib/contentBlockerList.js » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: README.md |
| diff --git a/README.md b/README.md |
| index a5992562916a20dfcf9a9fb29cde27edda86912a..4c2c1c35bb39cbd54122f2c2ae68bdd4db52c618 100644 |
| --- a/README.md |
| +++ b/README.md |
| @@ -18,6 +18,20 @@ The required packages can be installed via [NPM](https://npmjs.org): |
| npm install |
| ``` |
| +### filterClasses.js |
| + |
| +The filterClasses module in `node_modules/filterClasses.js` is generated from |
| +the module in the `adblockpluscore` repository. It has been generated using |
| +JS Hydra, and small modifications made. If you need to re-generate the file run |
| +this command (adjusting the paths as appropriate): |
| + |
| +``` |
| +python buildtools/jshydra/abp_rewrite.py adblockpluscore/lib/filterClasses.js | grep -vi filterNotifier > ../abp2blocklist/node_modules/filterClasses.js |
| +``` |
| +You will then need to remove any references to the `utils` module from the |
| +generated file by hand. |
| + |
| + |
| ## Usage |
| ``` |
« no previous file with comments
|
« .hgignore ('k')
|
abp2blocklist.js » ('j')
|
lib/contentBlockerList.js » ('J')
