diff --git a/README b/README deleted file mode 100644 index e6c3a7d..0000000 --- a/README +++ /dev/null @@ -1,15 +0,0 @@ -HttpClient is a library to make it easier to interact with web servers from Arduino. - -Dependencies: -- Requires the new Ethernet library API (with DHCP and DNS) which is in Arduino 1.0. - -Installation: -- Click the "Download Zip" button on the right-hand-side of https://github.com/amcewen/HttpClient and save the file somewhere -- Run the Arduino IDE -- In the IDE, go to the Sketch -> Import Library -> Add Library... menu option -- Find the zip file that you saved in the first step, and choose that -- Check that it has been successfully added by opening the Sketch -> Import Library menu. You should now see HttpClient listed among the available libraries. - -In normal usage, handles the outgoing request and Host header. The returned status code is -parsed for you, as is the Content-Length header (if present). - diff --git a/README.md b/README.md new file mode 100644 index 0000000..81fce7c --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# HttpClient + +HttpClient is a library to make it easier to interact with web servers from Arduino. + +## Dependencies + +- Requires the new Ethernet library API (with DHCP and DNS) which is in Arduino 1.0 and later + +## Installation + +1. Click the "Download Zip" button on the right-hand-side of https://github.com/amcewen/HttpClient and save the file somewhere +1. Run the Arduino IDE +1. In the IDE, go to the Sketch -> Import Library -> Add Library... menu option +1. Find the zip file that you saved in the first step, and choose that +1. Check that it has been successfully added by opening the Sketch -> Import Library menu. You should now see HttpClient listed among the available libraries. + +## Usage + +In normal usage, handles the outgoing request and Host header. The returned status code is parsed for you, as is the Content-Length header (if present). + +Because it expects an object of type Client, you can use it with any of the networking classes that derive from that. Which means it will work with EthernetClient, WiFiClient and GSMClient. + +See the examples for more detail on how the library is used. +