Update README.markdown

neothematrix · neothematrix · commit f0ec1ffa59b3 · 2016-04-26T10:57:23.000+02:00
@lukecyca I included the current Wiki documentation on the Readme, it makes more sense to have these info directly here.
diff --git a/README.markdown b/README.markdown
@@ -1,14 +1,104 @@
 # PyZabbix #
 
-**PyZabbix** is a Python module for working with the [Zabbix API](https://www.zabbix.com/documentation/2.0/manual/appendix/api/api).
+**PyZabbix** is a Python module for working with the [Zabbix API](https://www.zabbix.com/documentation/3.0/manual/api/reference).
 
 [![Build Status](https://travis-ci.org/lukecyca/pyzabbix.png?branch=master)](https://travis-ci.org/lukecyca/pyzabbix)
 [![PyPi version](https://img.shields.io/pypi/v/pyzabbix.svg)](https://pypi.python.org/pypi/pyzabbix/)
 [![PyPi downloads](https://img.shields.io/pypi/dm/pyzabbix.svg)](https://pypi.python.org/pypi/pyzabbix/)
 
-## Documentation
+## Requirements
+* Tested against Zabbix 1.8 through 3.0
 
-See https://wiki.github.com/lukecyca/pyzabbix/
+## Documentation ##
+### Getting Started
+
+Install PyZabbix using pip:
+
+```bash
+$ pip install pyzabbix
+```
+
+You can now import and use pyzabbix like so:
+
+```python
+from pyzabbix import ZabbixAPI
+
+zapi = ZabbixAPI("http://zabbixserver.example.com")
+zapi.login("zabbix user", "zabbix pass")
+print "Connected to Zabbix API Version %s" % zapi.api_version()
+
+for h in zapi.host.get(output="extend"):
+    print h['hostid']
+```
+
+Refer to the [Zabbix API Documentation](https://www.zabbix.com/documentation/3.0/manual/api/reference) and the [PyZabbix Examples](https://github.com/lukecyca/pyzabbix/tree/master/examples) for more information.
+
+### Customizing the HTTP request
+PyZabbix uses the [requests](http://www.python-requests.org/en/latest/) library for http. You can customize the request parameters by configuring the [requests Session](http://docs.python-requests.org/en/latest/user/advanced/#session-objects) object used by PyZabbix.
+
+This is useful for:
+* Customizing headers
+* Enabling HTTP authentication
+* Enabling Keep-Alive
+* Disabling SSL certificate verification
+
+```python
+from pyzabbix import ZabbixAPI
+
+zapi = ZabbixAPI("http://zabbixserver.example.com")
+
+# Enable HTTP auth
+zapi.session.auth = ("http user", "http password")
+
+# Disable SSL certificate verification
+zapi.session.verify = False
+
+# Specify a timeout (in seconds)
+zapi.timeout = 5.1
+
+# Login (in case of HTTP Auth, only the username is needed, the password, if passed, will be ignored)
+zapi.login("http user", "http password")
+```
+
+### Enabling debug logging
+If you need to debug some issue with the Zabbix API, you can enable the output of logging, pyzabbix already uses the default python logging facility but by default, it logs to "Null", you can change this behavior on your program, here's an example:
+```python
+import sys
+import logging
+from pyzabbix import ZabbixAPI
+
+stream = logging.StreamHandler(sys.stdout)
+stream.setLevel(logging.DEBUG)
+log = logging.getLogger('pyzabbix')
+log.addHandler(stream)
+log.setLevel(logging.DEBUG)
+
+
+zapi = ZabbixAPI("http://zabbixserver.example.com")
+zapi.login('admin','password')
+```
+The expected output is as following:
+
+```
+Sending: {
+    "params": {
+        "password": "password",
+        "user": "admin"
+    },
+    "jsonrpc": "2.0",
+    "method": "user.login",
+    "id": 2
+}
+Response Code: 200
+Response Body: {
+    "jsonrpc": "2.0",
+    "result": ".................",
+    "id": 2
+}
+>>>
+```
+
+Further info on [PyZabbix Wiki](https://wiki.github.com/lukecyca/pyzabbix/)
 
 ## License ##
 LGPL 2.1   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
