Update README

Update example documentation Version bump
Naguissa · Jan 2, 2020 · eab1115 · eab1115
1 parent d88632d
commit eab1115
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,14 @@ For manual installation:
  * Rename to uMuxOutputLib.zip
  * Install library on Arduino
 
+
+## Documentation and extras ##
+
+You can find all documentation and extras in this repository: https://github.com/Naguissa/uMuxOutputLib_doc_and_extras
+
+Due GitHub limitations HTML documentation is not avaliable online, you need to download the zip.
+
+
 ## Usage ##
 
 ### Constructor: ###

diff --git a/examples/uMuxOutputLib_example/uMuxOutputLib_example.ino b/examples/uMuxOutputLib_example/uMuxOutputLib_example.ino
@@ -3,18 +3,16 @@
  *
  * It cycles among multiplexed outputs using a timer to control all pins.
  *
+ * Functionality example
  *
- * @copyright Naguissa
- * @author Naguissa
- * @email naguissa@foroelectro.net
- * @version 1.0.0
- * @created 2019-08-08
+ * @see <a href="https://github.com/Naguissa/uSevenSegmentLib">https://github.com/Naguissa/uSevenSegmentLib</a>
+ * @see <a href="https://github.com/Naguissa/uTimerLib">https://github.com/Naguissa/uTimerLib</a> - Needed dependecy
+ * @see <a href="https://www.foroelectro.net/librerias-arduino-ide-f29/usevensegmentlib-libreria-arduino-para-controlar-d-t193.html">https://www.foroelectro.net/librerias-arduino-ide-f29/usevensegmentlib-libreria-arduino-para-controlar-d-t193.html</a>
+ * @see <a href="mailto:naguissa@foroelectro.net">naguissa@foroelectro.net</a>
  */
-
 #include "Arduino.h"
 #include "uMuxOutputLib.h"
 
-
 // Pin definitions. Change to fit your needs
 #ifdef _VARIANT_ARDUINO_STM32_
 	int pins[8] = {D4, D5, D6};
@@ -26,7 +24,6 @@
 
 uMuxOutputLib muxed(3, 2, pins, muxes);
 
-
 int i = 0;
 uint8_t tmp;
 
@@ -39,7 +36,6 @@ void setup() {
 }
 
 
-
 void loop() {
 	delay(1000);
 

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=uMuxOutputLib
-version=1.0.1
+version=1.0.2
 author=Naguissa <naguissa@foroelectro.net>
 maintainer=Naguissa <naguissa@foroelectro.net>
 sentence=Arduino, ESP8266 and STM32 7-segment multiplexed outputs library