From 56f92ac1fffb9f4d2878fa505a7f2671b3526c6c Mon Sep 17 00:00:00 2001
From: soylentOrange <soylentOrange@users.noreply.github.com>
Date: Mon, 8 May 2023 11:43:17 +0200
Subject: [PATCH] Update README.md

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/README.md b/README.md
index a12aa84..87487ce 100644
--- a/README.md
+++ b/README.md
@@ -14,9 +14,71 @@ This hardware-based Pulse-Width-Modulation (PWM) library enables you to use the
 
 ## Table of Contents
 
+* [Why do we need this library](#why-do-we-need-this-library)
+* [Example](#example)
+* [Function Reference](#functions)
 * [Installation](#installation)
 
+---
+
+## Why do we need this library
+
+I needed a hardware PWM for a [***DigiSpark-board***](https://www.azdelivery.de/en/products/digispark-board) to drive a fan at 25kHz and didn't found a library supporting the [**ATTinyCore**](https://github.com/SpenceKonde/ATTinyCore).  
+If you have one of the boards and need a flexible hardware-based PWM, this library might also fit for you. Otherwise, I'm still happy to use it ;).
+
+> See the provided example on how to the library.
+
+--
+
+## Example
+A bare minimum example is given below:
+```c++
+#include "DigiSpark_PWM.h"  // https://github.com/soylentOrange/DigiSpark_PWM
+
+// Cretae instance of DigiSpark_PWM-class, connected to Pin-PB1
+// (This Pin is connected to the onboard LED)
+DigiSpark_PWM pwm = DigiSpark_PWM(PIN_PB1);
+
+// For connecting to Pin PB4 simply use:
+// DigiSpark_PWM pwm = DigiSpark_PWM();
+
+// begin PWM-output
+void setup() {
+  // initialize and start PWM-output @1Hz with 50% duty-cycle
+  pwm.begin(1, 50);
+}
+
+void loop() {
+  // nothing to do here, the LED will blink driven by the hardware PWM
+}
+```
+
+### Get example
+The example can be obtained from within the Arduino IDE in File->Examples->DigiSpark_PWM->DigiSpark_PWM_example. 
+
+---
 
+## Functions
+#### uint8_t begin(uint32_t frequency, uint8_t dutyCyclePercent) 
+This function initializes the library. Call before use...  
+Initial frequency (in Hz) and duty cycle (in percent) are given here.
+The funcion will return an error if PWM is unavailable:
+* ERROR_INVALID_PIN (0x02) - pwm is not supported on the pin,
+* or 0 if everything went well.
+#### uint8_t setDutyCycle(uint8_t dutyCyclePercent) 
+Dynamically set the duty cycle (in percent).
+The funcion will return an error if PWM is unavailable:
+* ERROR_NOT_INITIALIZED  (0x01) - pwm is not initialized yet,
+* ERROR_INVALID_PIN (0x02) - pwm is not supported on the pin,
+* or 0 if everything went well.
+#### uint8_t setFrequency(uint32_t frequency) 
+Dynamically set the freuqncy of the pwm (in Hz). The duty cycle will match the prevous setting.
+The funcion will return an error if PWM is unavailable:
+* ERROR_NOT_INITIALIZED  (0x01) - pwm is not initialized yet,
+* ERROR_INVALID_PIN (0x02) - pwm is not supported on the pin,
+* or 0 if everything went well. 
+#### uint8_t getPin()
+Returns the pin given during instanciation.
 ---
 
 ## Installation