Skip to content

Commit

Permalink
Reworked the explanation to use markdown, for prettier formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrian McEwen committed Nov 23, 2013
1 parent 4076ba1 commit 476406b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
15 changes: 0 additions & 15 deletions README

This file was deleted.

24 changes: 24 additions & 0 deletions README.md
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.

0 comments on commit 476406b

Please sign in to comment.