Opened 5 years ago

Closed 5 years ago

#1288 closed change (fixed)

Add basic usage instructions to the README

Reported by: fhd Assignee: fhd
Priority: P2 Milestone:
Module: Libadblockplus Keywords:
Cc: Blocked By:
Blocking: Platform: Unknown
Ready: yes Confidential: no
Tester: Verified working: no
Review URL(s):

http://codereview.adblockplus.org/5987679581765632/

Description

Background

The only real way to learn how to use Libadblockplus is, currently, to look at the shell example. But even that hardly explains the basic concepts - all it does is to offer a command line interface for Libadblockplus.

We should have some user friendly instructions and point to the API documentation (#116).

What to change

Document how to do basic things with examples:

  • Initialising the engine (mention FileSystem, LogSystem and WebRequest)
  • Adding and matching blocking filters
  • Generating element hiding CSS

Change History (4)

comment:1 Changed 5 years ago by fhd

  • Owner set to fhd

comment:2 Changed 5 years ago by fhd

  • Review URL(s) modified (diff)

comment:3 Changed 5 years ago by fhd

  • Status changed from new to reviewing

comment:4 Changed 5 years ago by fhd

  • Resolution set to fixed
  • Status changed from reviewing to closed
Note: See TracTickets for help on using tickets.