aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index ca6147f..72537c1 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Prerequisites
Python 3.4 or higher is required.
Additionally, [online_duration.py] uses the excellent [matplotlib] plotting
library.
-The versions the author is using are listed below.
+The versions below have been verified to work properly.
Software | Version
------------ | -------
@@ -21,7 +21,7 @@ Python | 3.5.1
Usage
-----
-The main package is located in the "vk/" directory.
+The main package resides in the "vk/" directory.
Also, a few scripts are supplied in the "bin/" directory to showcase the
package's capabilities.
@@ -29,10 +29,11 @@ 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.
-* [mutual_friends.py]: Learn who your ex and her new boyfriend are both friends
-with.
-* [track_status.py]: Track when people go online/offline.
-* [online_duration.py]: View/visualize the amount of time people spend online.
+* [mutual_friends.py] — Learn who your ex and her new boyfriend are both
+friends with.
+* [track_status.py] — Track when people go online/offline.
+* [online_duration.py] — View/visualize the amount of time people spend
+online.
[mutual_friends.py]: docs/mutual_friends.md
[track_status.py]: docs/track_status.md