update README with basic usage instructions - surf-adblock - Surf adblock web extension
(HTM) git clone git://git.codemadness.org/surf-adblock
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 3217c9e3ead5b5cf40df1e624e8475d93574ae1e
(DIR) parent 75a5ce0455bace5c6b20ef07ceb202bd0af02269
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sat, 16 Jul 2016 12:12:28 +0200
update README with basic usage instructions
Diffstat:
M README | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
---
(DIR) diff --git a/README b/README
@@ -1 +1,27 @@
-adblock parser (WIP)
+Adblock extension for surf
+==========================
+
+
+Install
+-------
+
+ make
+ doas make install
+
+
+Usage
+-----
+
+Download Adblock rules:
+
+ surf-adblock-dl > ~/.surf/adblockrules
+
+Start surf:
+
+ surf https://favoritewebsite.xxx/
+
+
+License
+-------
+
+ISC, see LICENSE file.