makeover for the README [ci skip]

decentral1se · decentral1se · commit 82837e4b5c92 · 2016-07-14T22:33:03.000+02:00
diff --git a/README b/README
diff --git a/README.rst b/README.rst
@@ -0,0 +1,61 @@
+python-readability
+==================
+
+Given a html document, it pulls out the main body text and cleans it up.
+
+This is a python port of a ruby port of `arc90's readability
+project <http://lab.arc90.com/experiments/readability/>`__.
+
+Installation
+------------
+
+It's easy using ``pip``, just run:
+
+::
+
+    $ pip install readability-lxml
+
+Usage
+-----
+
+::
+
+    >> import requests
+    >> from readability import Document
+    >>
+    >> response = requests.get('http://example.com')
+    >> doc = Document(response.text)
+    >> doc.title()
+    >> 'Example Domain'
+
+Change Log
+----------
+
+-  0.3 Added Document.encoding, positive\_keywords and
+   negative\_keywords
+-  0.4 Added Videos loading and allowed more images per paragraph
+-  0.5 Preparing a release to support Python versions 2.6, 2.7, 3.3 and
+   3.4
+-  0.6 Finally a release which supports Python versions 2.6, 2.7, 3.3
+   and 3.4
+
+Licensing
+=========
+
+This code is under `the Apache License
+2.0 <http://www.apache.org/licenses/LICENSE-2.0>`__ license.
+
+Thanks to
+---------
+
+-  Latest
+   `readability.js <https://github.com/MHordecki/readability-redux/blob/master/readability/readability.js>`__
+-  Ruby port by starrhorne and iterationlabs
+-  `Python port <https://github.com/gfxmonk/python-readability>`__ by
+   gfxmonk
+-  `Decruft
+   effort <http://www.minvolai.com/blog/decruft-arc90s-readability-in-python/>`__
+   to move to lxml
+-  "BR to P" fix from readability.js which improves quality for smaller
+   texts
+-  Github users contributions.
diff --git a/setup.py b/setup.py
@@ -19,7 +19,7 @@
     author_email="burchik@gmail.com",
     description="fast html to text parser (article readability tool) with python3 support",
     test_suite = "tests.test_article_only",
-    long_description=open("README").read(),
+    long_description=open("README.rst").read(),
     license="Apache License 2.0",
     url="http://github.com/buriy/python-readability",
     packages=['readability', 'readability.compat'],
