Opened on 08/29/2014 at 04:43:54 PM

Closed on 09/02/2014 at 03:13:26 PM

#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

Attachments (0)

Change History (4)

comment:1 Changed on 09/02/2014 at 07:26:53 AM by fhd

  • Owner set to fhd

comment:2 Changed on 09/02/2014 at 07:27:07 AM by fhd

  • Review URL(s) modified (diff)

comment:3 Changed on 09/02/2014 at 07:27:18 AM by fhd

  • Status changed from new to reviewing

comment:4 Changed on 09/02/2014 at 03:13:26 PM by fhd

  • Resolution set to fixed
  • Status changed from reviewing to closed

Add Comment

Modify Ticket

Change Properties
Action
as closed .
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from fhd.
Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.