Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added further explanations about usage #5

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added further explanations about usage #5

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
194b192
Added further explanations about usage
DandelionSprout May 7, 2018
d92c8c6
Incorporated feedback-based changes
DandelionSprout May 8, 2018
e687853
Update README.md
DandelionSprout May 8, 2018
e44328f
Added the newest feedback
DandelionSprout May 8, 2018
003ce91
Changed triple-backticks to single-backticks
DandelionSprout May 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,11 @@ generated file by hand.

## Usage

In a Unix or Node.js command prompt, use:
Create a WebKit block list ```output.json``` from the Adblock Plus filter list ```input.txt```:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please could you wrap the file names in this sentence in a single backtick instead of three?

```
node abp2blocklist.js < easylist.txt > easylist.json
node abp2blocklist.js < input.txt > output.json
```

This assumes that you're trying to convert an input file that'd be called _easylist.txt_, and that you've navigated to the file's correct folder through the _cd_ command. If the input file has a different name, replace _easylist.txt_ with the file's name.

## Tests

Unit tests live in the `tests/` directory. To run the unit tests ensure you have
Expand Down