1
0
mirror of https://github.com/arduino-libraries/ArduinoHttpClient.git synced 2025-04-19 21:22:15 +03:00

Reworked the explanation to use markdown, for prettier formatting

This commit is contained in:
Adrian McEwen 2013-11-23 11:31:26 +00:00
parent 4076ba18ad
commit 476406b1bc
2 changed files with 24 additions and 15 deletions

15
README
View File

@ -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).

24
README.md Normal file
View File

@ -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.