initial commit

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d40a48
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# VK scripts
+
+A collection of scripts abusing VK.com API.
+
+## Usage
+
+To use this software, you need to be able to run Python 3 scripts.
+
+### track_online.py
+
+Track when people go online/offline:
+
+    track_online.py [SCREEN_NAME...]
+
+For example,
+
+    track_online.py egor.tensin id5245998
+
+### print_mutual_friends.py
+
+Learn who your ex and her new boyfriend are both friends with:
+
+    print_mutual_friends.py [SCREEN_NAME...]
+
+For example,
+
+    print_mutual_friends.py egor.tensin durov
+
+## Licensing
+
+This project, including all of the files and their contents, is licensed under the terms of the MIT License.
+See LICENSE.txt for details.