[tor-commits] [metrics-tasks/master] task-6329: Add a proper README file

[karsten at torproject.org]

commit 5af3e23d0160c097f02b1342821fa59174834b26
Author: delber <delber at riseup.net>
Date:   Sat Jul 14 12:05:15 2012 +0000

    task-6329: Add a proper README file
---
 task-6329/README              |   53 +++++++++++++++++++++++++++++++++++++++++
 task-6329/tor-relays-stats.py |   11 --------
 2 files changed, 53 insertions(+), 11 deletions(-)

diff --git a/task-6329/README b/task-6329/README
new file mode 100644
index 0000000..51f9dd7
--- /dev/null
+++ b/task-6329/README
@@ -0,0 +1,53 @@
+tor-relay-stats.py
+==================
+
+This script extract some statistics about relays using aggregate data
+based on the current consensus.
+
+Usage
+-----
+
+Usage: tor-relays-stats.py <output> [args ...]
+
+Where <output> is one of:
+ - countries [FLAGS]
+   relative percentage of the consensus in each countries
+ - as-sets [FLAGS] [COUNTRIES]
+   relative percentage of the consensus in each AS sets
+ - top [COUNT] [FLAGS] [COUNTRIES]
+   top relays according their place in the whole consensus
+
+Examples:
+
+ - To get the top five exit nodes in France:
+   tor-relays-stats.py top 5 Exit fr
+ - To get weights of each AS of all relays in Germany:
+   tor-relays-stats.py as-sets Running de
+
+Retrieving the data
+-------------------
+
+This script expect to have a file called 'details.json' in the
+current directory. In order to retrieve the needed data, one
+can issue the following command:
+
+    curl -o details.json https://onionoo.torproject.org/details
+
+Dependencies
+------------
+
+Written and tested on Python 2.6.6.
+
+Author
+------
+
+ * delber <delber at riseup.net>
+
+Licence
+-------
+
+This program is free software. It comes without any warranty, to
+the extent permitted by applicable law. You can redistribute it
+and/or modify it under the terms of the Do What The Fuck You Want
+To Public License, Version 2, as published by Sam Hocevar. See
+http://sam.zoy.org/wtfpl/COPYING for more details.
diff --git a/task-6329/tor-relays-stats.py b/task-6329/tor-relays-stats.py
index 822317a..245865f 100755
--- a/task-6329/tor-relays-stats.py
+++ b/task-6329/tor-relays-stats.py
@@ -1,16 +1,5 @@
 #!/usr/bin/env python
 #
-# tor-relay-stats.py: extract some statistics about relays
-#
-# This script expect to have a file called 'details.json' in the
-# current directory. In order to retrieve the needed data, one
-# can issue the following command:
-#
-#     curl -o details.json https://onionoo.torproject.org/details
-#
-#
-# Author: delber at riseup.net
-#
 # This program is free software. It comes without any warranty, to
 # the extent permitted by applicable law. You can redistribute it
 # and/or modify it under the terms of the Do What The Fuck You Want