From 824ec51280705dcdf37a7d13e174fb90acf5b884 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Fri, 25 Jan 2013 11:12:28 -0600 Subject: [PATCH] Add usage to readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c13d54..38fda19 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,19 @@ Command line interface for testing internet bandwidth using speedtest.net speedtest-cli is written for use with Python 2.4-2.7 -speedtest-cli-3 is written for use with Python 3 \ No newline at end of file +speedtest-cli-3 is written for use with Python 3 + +## Usage + + $ speedtest-cli -h + usage: speedtest-cli [-h] [--share] [--simple] + + Command line interface for testing internet bandwidth using speedtest.net. + -------------------------------------------------------------------------- + https://github.com/sivel/speedtest-cli + + optional arguments: + -h, --help show this help message and exit + --share Generate and provide a URL to the speedtest.net share results + image + --simple Suppress verbose output, only show basic information \ No newline at end of file