From ed7c00eabb94c12d90ce788e1ff6db68f5a19307 Mon Sep 17 00:00:00 2001
From: David vonThenen <12752197+dvonthenen@users.noreply.github.com>
Date: Wed, 12 Jun 2024 06:43:58 -0700
Subject: [PATCH] Clarify Example Support for Windows

---
 README.md                                           | 6 +++++-
 examples/README.md                                  | 2 ++
 examples/streaming/async_microphone/README.md       | 4 ++--
 examples/streaming/legacy_dict_microphone/README.md | 6 +++++-
 examples/streaming/microphone/README.md             | 4 ++--
 5 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 3a7a0c59..8c01194d 100644
--- a/README.md
+++ b/README.md
@@ -169,7 +169,11 @@ print("Finished")
 
 There are examples for **every** API call in this SDK. You can find all of these examples in the [examples folder](https://github.com/deepgram/deepgram-python-sdk/tree/main/examples) at the root of this repo.
 
-These examples provide:
+Before running any of these examples, then you need to take a look at the README and install the following dependencies:
+
+```bash
+pip install -r examples/requirements-examples.txt
+```
 
 Text to Speech:
 
diff --git a/examples/README.md b/examples/README.md
index 2ec30bd3..9f361901 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -13,6 +13,8 @@ In order to run the code in the `examples` folder, you first need to:
 pip install -r requirements-examples.txt
 ```
 
+| **IMPORTANT:** The microphone examples may not work out-of-the-box on Windows due to the portaudio dependency. Modifications to the example code and correct installation/configuration of the portaudio library are required.
+
 ## Steps to Test Your Code
 
 If you are contributing changes to this SDK, you can test those changes by using the `prerecorded`, `streaming`, or `manage` "hello world"-style applications in the `examples` folder. Here are the steps to follow:
diff --git a/examples/streaming/async_microphone/README.md b/examples/streaming/async_microphone/README.md
index 21af442f..848564ec 100644
--- a/examples/streaming/async_microphone/README.md
+++ b/examples/streaming/async_microphone/README.md
@@ -1,10 +1,10 @@
 # Live API (Real-Time) Example
 
-This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
+This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
 
 ## Prerequisites
 
-This example will only work on Linux and MacOS. Windows platforms are not supported.
+This example will only work on Linux and macOS. Windows platforms are not supported.
 
 ## Configuration
 
diff --git a/examples/streaming/legacy_dict_microphone/README.md b/examples/streaming/legacy_dict_microphone/README.md
index 6e3c21ae..848564ec 100644
--- a/examples/streaming/legacy_dict_microphone/README.md
+++ b/examples/streaming/legacy_dict_microphone/README.md
@@ -1,6 +1,10 @@
 # Live API (Real-Time) Example
 
-This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly. 
+This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
+
+## Prerequisites
+
+This example will only work on Linux and macOS. Windows platforms are not supported.
 
 ## Configuration
 
diff --git a/examples/streaming/microphone/README.md b/examples/streaming/microphone/README.md
index 21af442f..848564ec 100644
--- a/examples/streaming/microphone/README.md
+++ b/examples/streaming/microphone/README.md
@@ -1,10 +1,10 @@
 # Live API (Real-Time) Example
 
-This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
+This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
 
 ## Prerequisites
 
-This example will only work on Linux and MacOS. Windows platforms are not supported.
+This example will only work on Linux and macOS. Windows platforms are not supported.
 
 ## Configuration