From 5e4c2c7da9de4f34ea33431b4517a6775a852072 Mon Sep 17 00:00:00 2001
From: Jamie Hardt <jamiehardt@me.com>
Date: Tue, 29 Dec 2020 12:17:31 -0800
Subject: [PATCH] Doc

---
 src/lib.rs | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 4a92710..41236cf 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -3,6 +3,23 @@
  
 Rust Wave File Reader/Writer with Broadcast-WAV, MBWF and RF64 Support
 
+## Interfaces
+
+### `WaveReader`
+
+`WaveReader` can open and parse a Wave, Broadcast-Wave, or RF64/BW64 64-bit 
+wave file. Metadata can be accessed and parsed in arbitrary order and audio
+samples can be accessed using the `AudioFrameReader` type, created by an 
+accessor method of `WaveReader`.
+
+### `WaveWriter`
+
+`WaveWriter` can create a new Wave, Broadcast-Wave, or RF64/BW64 64-bit wave 
+file. Metadata chunks and audio samples are added sequentially, write-only, to 
+a Wave file which is automatically promoted from standard Wave to RF64 wave 
+when the total WAVE form size exceeds 0xFFFFFFFF bytes.
+
+
 ## Objectives and Roadmap
 
 This package aims to support read and writing any kind of WAV file you are likely