forked from rg1220/HttpClient
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reworked the explanation to use markdown, for prettier formatting
- Loading branch information
Adrian McEwen
committed
Nov 23, 2013
1 parent
4076ba1
commit 476406b
Showing
2 changed files
with
24 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|