updating readme

README.md

@@ -3,22 +3,21 @@
 
 # TM1638plus 
 
-Table of contents
----------------------------
+## Table of contents
 
   * [Overview](#overview)
   * [Installation](#installation)
   * [Software](#software)
   * [Connections](#connections)
   * [Model Types](#model-types)
-  * [Model One](#model-one)
-  * [Model Two](#model-two)
-  * [Model Three](#model-three)
+     * [Model One](#model-one)
+     * [Model Two](#model-two)
+     * [Model Three](#model-three)
   * [Tested](#tested)
   * [Notes](#notes)
 
-Overview
---------------------------------------------
+## Overview
+
 * Name: TM1638plus
 * Description: 
 
@@ -27,8 +26,7 @@ This library supports all 3 of the known models on market. see Model type sectio
 
 * Main Author: Gavin Lyons.
 
-Installation
-------------------------------
+## Installation
 
 The library is included in the official Arduino library manger and the optimum way to install it 
 is using the library manager which can be opened by the *manage libraries* option in Arduino IDE. 
@@ -38,18 +36,14 @@ See link below for instruction for this and for the other methods too.
 
 [Installing Additional Arduino Libraries guide](https://www.arduino.cc/en/Guide/Libraries)
 
-Software 
-----------------------------
-
-API
+## Software 
 
 The API (application programming interface)  html documentation is at link. Hosted on github pages and generated by Doxygen software. Here the user will find lots of information on files, functions & data types. 
 
 [Software API Url Link](https://gavinlyonsrepo.github.io/misc/software_docs/TM1638plus/index.html)
 
 
-Connections
-----------------------
+## Connections
 
 Connections to MCU: 
 
@@ -59,8 +53,7 @@ Connections to MCU:
 	* GND
 	* VCC 
 
-Model Types
--------------------------------
+## Model Types
 
 This library supports three variants of the TM1638, which for purposes of this documentation, 
 will be named Model 1 ,Model 2 and Model 3.  Pictured left to right. 
@@ -74,8 +67,7 @@ will be named Model 1 ,Model 2 and Model 3.  Pictured left to right.
 | Model 3 | TM1638 V1.3 or LKM1638  | 8 bi color,  red or green  | 8 |
 
 
-Model One
---------------------------------------
+### Model One
 
 TM1638 Module 8 Push buttons 8 LEDS (LED & KEY)
 
@@ -93,8 +85,7 @@ debouncing left out to minimise library size. Example files show some methods to
 User can Adjust brightness of module. Support 8 degree brightness adjustment.
 It is possible to manually set segments to create custom patterns without reference to the ASCII font.
 
-Model Two
------------------------------------------
+### Model Two
 
 TM1638 Module 16 Push buttons (16 KEY) (QYF).
 
@@ -111,8 +102,8 @@ See TM1638plus_ADC_TEST_Model2.ino for debounce button example.
 Two different functions to read buttons. 
 Raw ASCII data can be printed without reference to font file.
 
-Model Three
------------------------------------------
+### Model Three
+
 
 There are different PCB's of these modules on market, 
 This library was tested on no 3 below. I think this software will work for all of them 
@@ -128,7 +119,7 @@ giving a total of 8 digits.
 
 ![ module ](https://github.com/gavinlyonsrepo/TM1638plus/blob/master/extra/images/tm16384.jpg)
 
-**Model 3 LED Functions**
+*Model 3 LED Functions*
 
 The code is the same as model 1 and there is one unique model 3 example file. 
 setLED and setLEDs functions behaviour is the only difference in code base between 1 and 3.
@@ -146,8 +137,8 @@ SetLEDs: When you pass call the setLEDs function you can pass a word pattern whe
 1. Model 3 setLEDs(word) = 0xGGRR
 3. Model 1 setLEDs(word) = 0xRR00
 
-Tested
-------------------------------
+## Tested
+
 
 * Tested on following MCU  & Development platforms.
 * Examples files are set up for Arduino UNO & NANO v3.
@@ -160,8 +151,7 @@ Tested
 5. ESP8266.
 6. Teensy 4.0. (may not work at highest frequency see  note #2 in notes section)
 
-Notes
---------------------------
+## Notes
 
 1. Swapped data on Display issue on some Model 2 modules
 2. Anomaly's  on High frequency micro-controllers.