From 91cbff0b5662515f1850e0ad296f6b8913f9cc2d Mon Sep 17 00:00:00 2001
From: Francesco Laurita <taganaka@gmail.com>
Date: Sun, 5 Jun 2016 19:53:38 -0700
Subject: [PATCH] README file added

---
 CMakeLists.txt |  6 +++--
 README.md      | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 34866cb..499e57a 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -16,7 +16,7 @@ set (SpeedTest_API_KEY "297aae72")
 
 
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall -Wno-unused-result")
 
 set(SOURCE_FILES
         main.cpp
@@ -49,4 +49,6 @@ else()
 endif()
 
 include_directories(${CURL_INCLUDE_DIRS} ${LIBXML2_INCLUDE_DIR})
-target_link_libraries(SpeedTest ${CURL_LIBRARIES} ${LIBXML2_LIBRARIES} -lssl -lcrypto)
\ No newline at end of file
+target_link_libraries(SpeedTest ${CURL_LIBRARIES} ${LIBXML2_LIBRARIES} -lssl -lcrypto)
+
+install(TARGETS SpeedTest RUNTIME DESTINATION bin)
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..df1d278
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# SpeedTest++
+
+Yet another unofficial speedtest.net client cli interface
+
+It supports the new (undocumented) raw TCP protocol for better accuracy.
+
+## Features
+
+1. Best server discovery based on speed and distance from you.
+
+2. Line type discovery to select the best test profile based on your line speed.
+
+3. Aggressive multi-threading program in order to saturate your bandwidth quickly.
+
+4. Provide a URL to the speedtest.net share results image using option --share
+
+## Installation
+
+### Requirements
+
+1. A modern C++ compiler
+2. cmake
+3. libcurl
+4. libssl
+
+### On Mac OS X
+
+```
+$ brew install cmake
+$ cd cmake_build
+$ cmake -DCMAKE_BUILD_TYPE=Release ..
+$ make install
+```
+
+### On Ubuntu/Debian
+
+```
+$ sudo apt-get install build-essentials libcurl4-openssl-dev libssl-dev cmake
+$ cd cmake_build
+$ cmake -DCMAKE_BUILD_TYPE=Release ..
+$ make install
+```
+
+## Usage
+
+```
+$ SpeedTest --help
+SpeedTest++ version 1.0
+speedtest.net command line interface
+Author: Francesco Laurita <francesco.laurita@gmail.com>
+
+usage: SpeedTest [--latency] [--download] [--upload] [--help]
+optional arguments:
+	--help      Show this message and exit
+	--latency   Perform latency test only
+	--download  Perform download test only. It includes latency test
+	--upload    Perform upload test only. It includes latency test
+	--share     Generate and provide a URL to the speedtest.net share results image
+$
\ No newline at end of file