Skip to content

Commit 476406b

Browse files
author
Adrian McEwen
committed
Reworked the explanation to use markdown, for prettier formatting
1 parent 4076ba1 commit 476406b

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

README

Lines changed: 0 additions & 15 deletions
This file was deleted.

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# HttpClient
2+
3+
HttpClient is a library to make it easier to interact with web servers from Arduino.
4+
5+
## Dependencies
6+
7+
- Requires the new Ethernet library API (with DHCP and DNS) which is in Arduino 1.0 and later
8+
9+
## Installation
10+
11+
1. Click the "Download Zip" button on the right-hand-side of https://github.com/amcewen/HttpClient and save the file somewhere
12+
1. Run the Arduino IDE
13+
1. In the IDE, go to the Sketch -> Import Library -> Add Library... menu option
14+
1. Find the zip file that you saved in the first step, and choose that
15+
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.
16+
17+
## Usage
18+
19+
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).
20+
21+
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.
22+
23+
See the examples for more detail on how the library is used.
24+

0 commit comments

Comments
 (0)