Improve Readme

areski · areski · commit ad3123f3e8ee · 2014-10-15T18:26:10.000+02:00
diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+===============
 influxdb-python
 ===============
 
@@ -7,18 +8,88 @@ influxdb-python
 [![Supported Python versions](https://pypip.in/py_versions/influxdb/badge.svg)](https://pypi.python.org/pypi/influxdb/)
 [![License](https://pypip.in/license/influxdb/badge.svg)](https://pypi.python.org/pypi/influxdb/)
 
-Python client for InfluxDB
+About
+=====
 
-For developers
---------------
+InfluxDB-Python is a client for interacting with [InfluxDB](http://influxdb.com/).
 
-### Uploading
+InfluxDB is an open-source distributed time series database, find more about at http://influxdb.com/
 
-```
-$ python setup.py sdist upload
-```
 
-### Testing
+Installation
+============
+
+Install, upgrade and uninstall InfluxDB-Python with these commands:
+
+````
+$ pip install influxdb
+$ pip install --upgrade influxdb
+$ pip uninstall influxdb
+````
+
+
+Dependencies
+============
+
+The InfluxDB-Python distribution is supported and tested on Python 2.7 and Python 3.3.
+Requests
+
+Additional dependencies are:
+
+- Sphinx: to generate documentation
+- Nose & Mock: to auto-discover & mock tests
+
+
+Documentation
+=============
+
+InfluxDB-Python documentation is available at [ADD_LINK](https://readthedocs.org/)
+
+You will need [Sphinx](http://sphinx.pocoo.org/) installed to generate the
+documentation.
+
+The documentation can be generated by running:
+
+````
+python setup.py doc
+````
+
+Generated documentation can be found in the *doc/build/html/* directory.
+
+
+Examples
+========
+
+Here's a basic example (for more see the examples directory):
+
+````
+$ python
+
+>>> from influxdb import InfluxDBClient
+
+>>> json_body = [{
+    "points": [
+        ["1", 1, 1.0],
+        ["2", 2, 2.0]
+    ],
+    "name": "foo",
+    "columns": ["column_one", "column_two", "column_three"]
+}]
+
+>>> client = InfluxDBClient('localhost', 8086, 'root', 'root', 'example')
+
+>>> client.create_database('example')
+
+>>> client.write_points(json_body)
+
+>>> result = client.query('select column_one from foo;')
+
+>>> print("Result: {0}".format(result))
+````
+
+
+Testing
+=======
 
 Make sure you have tox by running the following:
 
@@ -37,3 +108,16 @@ If you don't have all Python version listed in tox.ini, then
 ````
 $ tox -e py27
 ````
+
+
+Support
+=======
+
+For issues with, questions about, or feedback for InfluxDB, please look into
+our community page: http://influxdb.com/community/.
+
+
+Source code
+===========
+
+The source code is currently available on [https://github.com/influxdb/influxdb-python](https://github.com/influxdb/influxdb-python).
