From b318c57dc7ef1bcab3433df163c1da0f89f745d7 Mon Sep 17 00:00:00 2001
From: Harshad Sharma <harshad@sharma.io>
Date: Sat, 17 Jun 2017 01:03:37 +0530
Subject: [PATCH] Update readme.

---
 README.rst | 83 ++++++++++++++----------------------------------------
 1 file changed, 21 insertions(+), 62 deletions(-)

diff --git a/README.rst b/README.rst
index 8f6179e..c58ac24 100644
--- a/README.rst
+++ b/README.rst
@@ -2,87 +2,46 @@
 Overview
 ========
 
-.. start-badges
 
-.. list-table::
-    :stub-columns: 1
-
-    * - docs
-      - |docs|
-    * - tests
-      - | |travis|
-        |
-    * - package
-      - | |version| |wheel| |supported-versions| |supported-implementations|
-        | |commits-since|
-
-.. |docs| image:: https://readthedocs.org/projects/python-qutescript/badge/?style=flat
-    :target: https://readthedocs.org/projects/python-qutescript
-    :alt: Documentation Status
-
-.. |travis| image:: https://travis-ci.org/hiway/python-qutescript.svg?branch=master
-    :alt: Travis-CI Build Status
-    :target: https://travis-ci.org/hiway/python-qutescript
-
-.. |version| image:: https://img.shields.io/pypi/v/qutescript.svg
-    :alt: PyPI Package latest release
-    :target: https://pypi.python.org/pypi/qutescript
-
-.. |commits-since| image:: https://img.shields.io/github/commits-since/hiway/python-qutescript/v0.1.0.svg
-    :alt: Commits since latest release
-    :target: https://github.com/hiway/python-qutescript/compare/v0.1.0...master
-
-.. |wheel| image:: https://img.shields.io/pypi/wheel/qutescript.svg
-    :alt: PyPI Wheel
-    :target: https://pypi.python.org/pypi/qutescript
-
-.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/qutescript.svg
-    :alt: Supported versions
-    :target: https://pypi.python.org/pypi/qutescript
-
-.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/qutescript.svg
-    :alt: Supported implementations
-    :target: https://pypi.python.org/pypi/qutescript
+Painless userscripts for qutebrowser.
 
+* Free software: BSD license
 
-.. end-badges
+Status
+======
 
-Painless userscripts for qutebrowser.
+Very alpha, "works for me" on MacOS Sierra with Python 3.6;
+if you like what you see, please test it on your platform
+and help by submitting pull-requests if your current skills
+allow.
 
-* Free software: BSD license
 
 Installation
 ============
 
 ::
 
-    pip install qutescript
+    git clone https://github.com/hiway/python-qutescript.git qutescript
+    cd qutescript
+    pip install -e .
 
-Documentation
-=============
 
-https://python-qutescript.readthedocs.io/
+Usage
+=====
 
-Development
-===========
+::
 
-To run the all tests run::
+    #!/usr/bin/env python
 
-    tox
+    from qutescript import userscript
 
-Note, to combine the coverage data from all the tox environments run:
 
-.. list-table::
-    :widths: 10 90
-    :stub-columns: 1
+    @userscript
+    def hello_world(request):
+        request.send_text('Hello, world!')
 
-    - - Windows
-      - ::
 
-            set PYTEST_ADDOPTS=--cov-append
-            tox
+    if __name__ == '__main__':
+        hello_world()
 
-    - - Other
-      - ::
 
-            PYTEST_ADDOPTS=--cov-append tox