Skip to content

Commit 02a4e8e

Browse files
author
Giuseppe Masino
committed
Updated README
Added a notice on how to find documentation Changed badge style
1 parent ea3368d commit 02a4e8e

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# HTTP/1.1 for Arduino #
1+
<center><h1> HTTP/1.1 for Arduino </h1></center>
22

3-
![Project status badge](https://img.shields.io/badge/Project%20status-ACTIVE-brightgreen.svg)
4-
[![License badge](https://img.shields.io/badge/license-custom%20CC%20BY--SA%204.0-brightgreen.svg)](https://github.com/qub1750ul/Arduino_HTTP/blob/master/LICENSE.md)
5-
[![Arduino Library specification badge](https://img.shields.io/badge/Arduino%20Library%20Specification%20-rev.%202.1-blue.svg)](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification)
6-
[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-blue.svg)](https://www.arduino.cc/en/Main/Software)
7-
[![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com)
8-
[![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org)
3+
[![License badge](https://img.shields.io/badge/license-custom%20CC%20BY--SA%204.0-brightgreen.svg?style=for-the-badge)](https://github.com/qub1750ul/Arduino_HTTP/blob/master/LICENSE.md)
4+
5+
[![Arduino Library specification badge](https://img.shields.io/badge/Arduino%20Library%20Specification%20-rev%202.1-00878F.svg?style=for-the-badge)](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification)
6+
[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-00878F.svg?style=for-the-badge)](https://www.arduino.cc/en/Main/Software)
7+
8+
[![Keep a Changelog badge](https://img.shields.io/badge/Keep%20a%20Changelog-1.0.0-orange.svg?style=for-the-badge)](http://keepachangelog.com)
9+
[![Semantic Versioning badge](https://img.shields.io/badge/Semantic%20Versioning-2.0.0-orange.svg?style=for-the-badge)](http://semver.org)
10+
[![Git Flow badge](https://img.shields.io/badge/Git%20Flow--transparent.svg?style=for-the-badge&logo=git)](https://nvie.com/posts/a-successful-git-branching-model/)
911

1012
## Description ##
1113

@@ -24,6 +26,17 @@ Powerful and easy to use.
2426

2527
[Checkout the wiki for more information](https://github.com/qub1750ul/Arduino_HTTP/wiki/)
2628

29+
**DEVELOPER NOTICE :**
30+
31+
1. Currently this is a functional implementation of HTTP.
32+
It's my intention to complete it as stated above, but when this will happen
33+
is undefined.
34+
35+
2. Currently i'm too lazy / busy to write a proper documentation page.
36+
However the source code is very well documented in doxygen style, so if you're
37+
searching for documentation your current options are either to directly look for comments in the source or try using doxygen.
38+
The choice is yours.
39+
2740
## About the author & license info ##
2841

2942
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">

0 commit comments

Comments
 (0)