Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Added a notice on how to find documentation
Changed badge style
  • Loading branch information
Giuseppe Masino committed Jan 30, 2019
1 parent ea3368d commit 02a4e8e
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# HTTP/1.1 for Arduino #
<center><h1> HTTP/1.1 for Arduino </h1></center>

![Project status badge](https://img.shields.io/badge/Project%20status-ACTIVE-brightgreen.svg)
[![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)
[![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)
[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-blue.svg)](https://www.arduino.cc/en/Main/Software)
[![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com)
[![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org)
[![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)

[![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)
[![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)

[![Keep a Changelog badge](https://img.shields.io/badge/Keep%20a%20Changelog-1.0.0-orange.svg?style=for-the-badge)](http://keepachangelog.com)
[![Semantic Versioning badge](https://img.shields.io/badge/Semantic%20Versioning-2.0.0-orange.svg?style=for-the-badge)](http://semver.org)
[![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/)

## Description ##

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

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

**DEVELOPER NOTICE :**

1. Currently this is a functional implementation of HTTP.
It's my intention to complete it as stated above, but when this will happen
is undefined.

2. Currently i'm too lazy / busy to write a proper documentation page.
However the source code is very well documented in doxygen style, so if you're
searching for documentation your current options are either to directly look for comments in the source or try using doxygen.
The choice is yours.

## About the author & license info ##

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

0 comments on commit 02a4e8e

Please sign in to comment.