* Dropped pytz support, `dateutil` version 2.2 or higher is now required.
[diaspy.git] / README.md
index e77a0bf8f92805a70eccadeaeaf4ae77c51b5172..d135fbfb38083f73ad798b429808afef0f51eb77 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-#### Unofficial Python interface for Diaspora\* social network
+## Unofficial Python interface for Diaspora\* social network
+
+[![Diaspy on PyPI](https://badge.fury.io/py/diaspy-api.png)](https://pypi.python.org/pypi/diaspy-api)
 
 `diaspy` is a set of modules which form an Python interface to the API of
 Disapora\* social network. 
@@ -15,6 +17,33 @@ can use only `diaspy.connection.Connection()` object as it is capable of
 doing everything. Other modules are just layers that provide easier access to
 parts of the Diaspora\* API.
 
+----
+
+### Dependencies
+
+List of software `diaspy` requires to run.
+Versions used by maintainer are the ones available in stock Arch x86\_64 repositories.
+
+**`python`**
+
+Version: 3.3.3
+[Website](https://www.python.org/)
+
+
+**`python-requests`**
+
+Version: 2.1.0
+[Website](http://docs.python-requests.org/en/latest/)
+
+**`python-dateutil`**
+
+Version: >= 2.2
+[Website](https://github.com/dateutil/dateutil)
+
+*Optional:* **`python-beautifulsoup4`**
+[Website](https://www.crummy.com/software/BeautifulSoup/)
+
+
 ----
 
 #### Quick intro
@@ -31,6 +60,7 @@ You only need two objects to do this: `Stream()` and `Connection()`.
     >>> stream = diaspy.streams.Stream(c)
     >>> stream.post('Your first post')
 
+----
 
 #### 2. Reference implementation