Completely remove adblock for now

[chorizo.git] / README

diff --git a/README b/README
index f89e5cdd8995cabc3993b8e9a58c1727890d22bc..5f25e00366f800041b37b065c1e94b7b6df30bfe 100644 (file)
--- a/README
+++ b/README
@@ -4,21 +4,20 @@
                                ==========
 
 
-A simple web browser using GTK+ 2, GLib and WebKitGTK+.
+A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 
 Features:
 
-    - A WebKit viewport
+    - A WebKit2 viewport
     - An input box to change the URI or to search the current page
     - Built-in launching of suckless' tabbed
-    - Built-in adblock
     - Built-in download manager
     - Optimized hotkeys: Left hand on keyboard, right hand on mouse
     - Keyword based searching: Opening "wi foo" will search wikipedia
     - Global content zoom
     - View source mode
     - Cooperative instances using FIFOs
-    - Support for Flash and Java
+    - Support for Java
 
 
 ==============
@@ -64,6 +63,12 @@ persistent storage, nor a plugin system, nor cloud sync, nor bookmarks.
 
 lariza tries not to exceed 1000 lines of code.
 
+That being said, this kind of minimalism is not for everyone. If you're
+looking for more features (and a more open feature policy), then you
+might want to check out okraits' fork:
+
+    https://github.com/okraits/lariza/
+
 
 ========================
 Using lariza with tabbed
@@ -96,8 +101,8 @@ Main windows
             Close the current window.
 
         Mod1 + w
-            Go to your "homepage" which is the first URI specified on
-            the command line.
+            Go to your "homepage". See the environment variable
+            $LARIZA_HOME_URI.
 
         Mod1 + e
             Open a new window.
@@ -196,7 +201,7 @@ following options:
         Disables automatic launching of suckless' tabbed.
 
 After these options there can be any number of URIs. If no URIs are
-given, about:blank will be opened.
+given, $LARIZA_HOME_URI will be opened.
 
 
 =====================
@@ -225,23 +230,17 @@ following environment variables:
         "main". If you change this variable, you can launch several
         independent cooperative instances of lariza.
 
-    LARIZA_ZOOM
-        Zoom level for WebKit viewports. Defaults to 1.0.
-
-
-=======
-Adblock
-=======
+    LARIZA_HOME_URI
+        This URI will be opened by pressing the appropriate hotkeys
+        ("homepage" or "new window") and if no URIs are specified on the
+        command line. Defaults to "about:blank".
 
-lariza has built-in adblock functionality. In each line of
+    LARIZA_USER_AGENT
+        Lariza will identify itself with this string. See source code
+        for the default value.
 
-    ~/.config/lariza/adblock.black
-
-you can store a regular expression. These expressions match
-case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
-and you can use anchors like "^https?://...".
-
-Lines starting with "#" are ignored.
+    LARIZA_ZOOM
+        Zoom level for WebKit viewports. Defaults to 1.0.
 
 
 =======================
@@ -296,8 +295,8 @@ Dependencies
 
 lariza needs the following Arch Linux packages:
 
-    - gtk2
-    - webkitgtk2
+    - gtk3
+    - webkit2gtk (WebKit2 API for GTK+ 3)
 
 
 ==========
@@ -307,10 +306,5 @@ Literature
 API references:
 
     - http://webkitgtk.org/reference/webkitgtk/stable/index.html
-    - https://developer.gnome.org/gtk2/stable/index.html
+    - https://developer.gnome.org/gtk3/stable/index.html
     - https://developer.gnome.org/glib/stable/index.html
-
-Regular expressions supported by GRegex, you can use these in your
-adblock patterns:
-
-    - https://developer.gnome.org/glib/stable/glib-regex-syntax.html