Diff: README.md

Revision:

0:f40a402e1725

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Tue May 02 15:29:27 2017 +0000
@@ -0,0 +1,31 @@
+### Getting started with the network-socket API ###
+
+This is a quick example of a simple HTTP client program using the
+network-socket API that is provided as a part of [mbed-os](github.com/armmbed/mbed-os).
+
+The program brings up an underlying network interface, and uses it to perform an HTTP
+transaction over a TCPSocket.
+
+**Note:** The current example is limited to the ethernet interface on supported devices.
+To use the example with a different interface, you will need to modify main.cpp and
+replace the EthernetInterface class with the appropriate interface.
+
+### Expected output ###
+
+```
+IP address: 10.118.14.45
+Netmask: 255.255.252.0
+Gateway: 10.118.12.1
+sent 39 [GET / HTTP/1.1]
+recv 173 [HTTP/1.1 200 OK]
+External IP address: 217.140.111.135
+Done
+```
+
+### Documentation ###
+
+More information on the network-socket API can be found in the [mbed handbook](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/network_sockets/).
+
+### Known issues
+
+- ARCH_PRO runtime fails for all toolchains - issue [here](https://github.com/ARMmbed/mbed-os-example-sockets/issues/17)