Adapted README and user markdown now.
authorDaniel Carl <danielcarl@gmx.de>
Sat, 23 Mar 2013 15:47:41 +0000 (16:47 +0100)
committerDaniel Carl <danielcarl@gmx.de>
Sat, 23 Mar 2013 15:47:41 +0000 (16:47 +0100)
README.md [new file with mode: 0644]
README.org [deleted file]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e27d509
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# vimb
+Vimb is a web browser that behaves like the Vimprobable but with some
+paradigms from dwb and hopefully a cleaner code base. The goal of Vimb is to
+build a completely keyboard-driven, efficient and pleasurable
+browsing-experience with low memory and cpu usage.
+
+## Features
+- vim-like modal
+- vim-like keybindings
+- nearly every configuration can be changed on runtime with `:set varname=value`
+  - allow to inspect the current set values of variables `:set varname?`
+  - allow to toggle boolean variables with `:set varname!`
+- keybindings for each browser mode assignable
+- the center of `vimb` are the commands that can be called from inputbox or
+  via keybinding
+- history for
+  - commands
+  - search queries
+  - urls
+- completions for
+  - commands
+  - urls
+  - variable names of settings
+- hinting - marks links, form fields and other clickable elements to be
+  clicked, opened or inspected
+- webinspector that opens ad the bottom of the browser window like in some
+  other fat browsers
+- ssl validation against ca-certificate file
+
+## Dependencies
+- libwebkit-1.0
+- libgtk+-2.0
+- libsoup-2.4
+
+# License
+Information about the license are found in the file LICENSE.
diff --git a/README.org b/README.org
deleted file mode 100644 (file)
index bd4151a..0000000
+++ /dev/null
@@ -1,17 +0,0 @@
-* vimb
-  Vimb is a web browser that behaves like the Vimprobable but with some
-  paradigms from dwb and hopefully a cleaner code base. The goal of Vimb is to
-  build a completely keyboard-driven, efficient and pleasurable
-  browsing-experience with low memory and cpu usage.
-** Features
-   - fully keyboard controllable
-   - change setting to runtime
-   - add and remove keybindings to runtime
-   - cookie support
-   - ssl validation against ca-file
-** Dependencies
-   - libwebkit-1.0
-   - libgtk+-2.0
-   - libsoup-2.4
-* License
-  Information about the license are found in the file LICENSE.