aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-06-21 03:00:38 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-06-21 03:00:38 +0300
commit28c4a78bc59ac558359154045a659cc7e0de65c1 (patch)
tree190ab69d12a1f0cd557de32a66d3cfecea0976e3 /README.md
parentdocs: update (diff)
downloadvk-scripts-28c4a78bc59ac558359154045a659cc7e0de65c1.tar.gz
vk-scripts-28c4a78bc59ac558359154045a659cc7e0de65c1.zip
README update
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0a9438d..db856b1 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,29 @@ VK scripts
==========
A collection of scripts abusing VK.com API.
+
+Prerequisites
+-------------
+
Requires Python 3.4 or higher.
+Additionally, [online_duration.py] requires the excellent [matplotlib] plotting
+library to be installed.
+The versions I used are listed below.
+
+Software | Version
+------------ | -------
+Python | 3.5.1
+[matplotlib] | 1.5.1
+
+[matplotlib]: http://matplotlib.org/
Usage
-----
The main package is located in the "vk/" directory.
-Additionally, a few scripts are supplied in the "bin/" directory to show-case
-the package's capabilities.
+Also, a few scripts are supplied in the "bin/" directory to showcase the
+package's capabilities.
Run the scripts from the top-level directory using `python -m`.
Pass the `--help` flag to a script to see its detailed usage information.
The supplied scripts are listed below.