filled in/finished the readme sections

Author: gigapod

README.md

@@ -23,14 +23,114 @@ Looking for the board that matches this library - pick up a [SparkFun Qwiic Buzz
 
 This library provides an interface that enables the following functionality when a SparkFun Qwiic Buzzer breakout board:
 
-* ***TODO***
-* 
+* Turn the buzzer on and off
+* Adjust the buzzers frequency and duration
+* Control the the volume of the buzzer
+* Play sound effects on the buzzer
+* Change the I2C address to enable the use of multiple buzzers on one device
 
 
 ## General Use
+The following outlines the general use of the library in an Arduino Sketch. 
 
-***TODO***
+### Declaration
 
+At the start of your sketch, the library header file is included using the following statement:
+
+~~~cpp
+#include <SparkFun_Qwiic_Buzzer_Arduino_Library.h>
+~~~
+
+Before the arduino ```setup()``` function, create a Buzzer object in your file with the following declaration:
+
+~~~c
+QwiicBuzzer buzzer; // its a buzzer
+~~~
+
+
+### Initialization
+
+In the Arduino ```setup()``` function, initialize the buzzer by calling the begin method. This method is called after the Arduino `Wire` (I2C) library is initialized. 
+
+~~~cpp
+//check if buzzer will connect over I2C
+if (buzzer.begin() == false) {
+Serial.println("Device did not connect! Freezing.");
+while (1);
+}
+~~~
+
+The begin method returns true if the buzzer is connected and available, and false if it is not. If a value of *false* is returned in the above example, the  sketch execution is halted.
+
+### Usage
+
+#### On/Off
+
+Turn the buzzer on and off as shown in the following loop example:
+
+~~~cpp
+void loop() {
+  buzzer.on();
+  
+  delay(1000);
+  
+  buzzer.off();
+  
+  delay(1000);
+}
+~~~
+
+#### Frequency Control
+
+The buzzer frequency is controlled using the ```configureBuzzer()``` method. 
+
+~~~cpp
+void loop() {
+  // Configure with desired settings
+  // Resonant frequency is 2.73KHz
+  buzzer.configureBuzzer(SFE_QWIIC_BUZZER_RESONANT_FREQUENCY); 
+  buzzer.on(); 
+  delay(100);
+  
+  buzzer.off();
+  delay(1000);
+
+  buzzer.configureBuzzer(1000); // set frequency to 1KHz
+  buzzer.on(); 
+  delay(100);
+  
+  buzzer.off();
+  delay(1000);
+}
+~~~
+
+#### Buzz Duration
+
+The buzz duration is set by adding a timing value after the frequency to the ```configureBuzzer()``` method.
+
+~~~cpp
+ buzzer.configureBuzzer(2730, 100); // frequency: 2.73KHz, duration: 100ms
+~~~
+
+#### Volume
+
+The buzz volume is an additional optional parameter to the ```configureBuzzer()``` method.
+
+~~~cpp
+buzzer.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MIN); // frequency: 2.73KHz, duration: 100ms, volume: MIN
+...
+buzzer.configureBuzzer(2730, 100, SFE_QWIIC_BUZZER_VOLUME_MAX); // frequency: 2.73KHz, duration: 100ms, volume: MAX
+~~~
+
+#### Sound Effects
+
+The buzzer has a collection of sound effects included in this library. These are started by using the ```playSoundEffect()``` method, providing the number of the sound effect to play.
+
+Playing sound effect 1:
+
+~~~cpp
+ err = buzzer.playSoundEffect(1, BUZZER_VOLUME);
+~~~
 ## Examples
 
 The following examples are provided with the library