aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/mutuals.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/mutuals.md')
-rw-r--r--docs/mutuals.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/mutuals.md b/docs/mutuals.md
index 39ee76f..eeaa23d 100644
--- a/docs/mutuals.md
+++ b/docs/mutuals.md
@@ -1,20 +1,18 @@
-mutual_friends.py
-=================
+vk-mutuals
+==========
Learn who your ex and her new boyfriend are both friends with.
Usage
-----
-Run from the top-level directory using `python -m`:
-
- > python -m bin.mutual_friends -h
- usage: mutual_friends.py [-h] [-f {csv,json}] [-o PATH] UID [UID ...]
+ > vk-mutuals -h
+ usage: vk-mutuals [-h] [-f {csv,json}] [-o PATH] UID [UID ...]
...
For example (using made up user IDs/"screen names"),
- > python -m bin.mutual_friends john.doe jane.doe
+ > vk-mutuals john.doe jane.doe
89497105,John,Smith
3698577,Jane,Smith
@@ -24,7 +22,7 @@ Smith" and "Jane Smith", whose user IDs are 89497105 and 3698577 respectively.
The output format is CSV (comma-separated values) by default.
You can also get a JSON document:
- > python -m bin.mutual_friends --format json john.doe jane.doe
+ > vk-mutuals --format json john.doe jane.doe
[
{
"uid": 89497105,