aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-05-04 00:50:07 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-05-04 00:50:07 +0300
commitf1a4bf0ce674b0b8ea3f05bd2d3605e19097244a (patch)
tree13fa56e9fa3b40d97097007e009053025785e101
parentworkflows/test: tweak step names (diff)
downloadvk-scripts-f1a4bf0ce674b0b8ea3f05bd2d3605e19097244a.tar.gz
vk-scripts-f1a4bf0ce674b0b8ea3f05bd2d3605e19097244a.zip
README: update
-rw-r--r--README.md50
-rw-r--r--docs/mutuals.md (renamed from docs/mutual_friends.md)0
-rw-r--r--docs/sessions.md (renamed from docs/online_sessions.md)0
-rw-r--r--docs/status.md (renamed from docs/track_status.md)0
4 files changed, 13 insertions, 37 deletions
diff --git a/README.md b/README.md
index f448066..9bdd9fe 100644
--- a/README.md
+++ b/README.md
@@ -5,47 +5,28 @@ VK scripts
A collection of scripts abusing VK.com API.
-Prerequisites
--------------
+Installation
+------------
-* Python 3.4 or higher
-* [matplotlib] (required by [online_sessions.py])
-* [numpy] (required by [matplotlib])
+ pip install vk-scripts
-The versions below have been verified to work properly.
-| Software | Version
-| ---------- | -------
-| CPython | 3.5.1
-| numpy | 1.11.0
-| matplotlib | 1.5.1
-
-Windows binaries for CPython can be acquired at
-http://www.lfd.uci.edu/~gohlke/pythonlibs/.
+Python 3.4 or higher is required.
+`vk-sessions` uses [matplotlib].
[matplotlib]: http://matplotlib.org/
-[numpy]: http://www.numpy.org/
Usage
-----
-The main package resides in the "vk/" directory.
-
-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 examine its detailed usage information.
-The supplied scripts are listed below.
+* [vk-mutuals] &mdash; Learn who your ex and her new boyfriend are both friends
+with.
+* [vk-status] &mdash; Track when people go online/offline.
+* [vk-sessions] &mdash; View/visualize the amount of time people spend online.
-* [mutual_friends.py] &mdash; Learn who your ex and her new boyfriend are both
-friends with.
-* [track_status.py] &mdash; Track when people go online/offline.
-* [online_sessions.py] &mdash; View/visualize the amount of time people spend
-online.
-
-[mutual_friends.py]: docs/mutual_friends.md
-[track_status.py]: docs/track_status.md
-[online_sessions.py]: docs/online_sessions.md
+[vk-mutuals]: docs/mutuals.md
+[vk-status]: docs/status.md
+[vk-sessions]: docs/sessions.md
Development
-----------
@@ -53,13 +34,8 @@ Development
### Linting
Requires [Pylint].
-To lint everything, run from the top-level directory:
-
- > pylint vk
- ...
- > pylint bin
- ...
+ pylint vk
[Pylint]: https://www.pylint.org/
diff --git a/docs/mutual_friends.md b/docs/mutuals.md
index 39ee76f..39ee76f 100644
--- a/docs/mutual_friends.md
+++ b/docs/mutuals.md
diff --git a/docs/online_sessions.md b/docs/sessions.md
index 7c9d4d4..7c9d4d4 100644
--- a/docs/online_sessions.md
+++ b/docs/sessions.md
diff --git a/docs/track_status.md b/docs/status.md
index 8fe0746..8fe0746 100644
--- a/docs/track_status.md
+++ b/docs/status.md