From 8a4ff4544fed203ca85c6e1500b51e3e32bbdd15 Mon Sep 17 00:00:00 2001
From: dclipca <dclipca@protonmail.com>
Date: Sat, 7 Dec 2024 00:04:23 +0200
Subject: [PATCH] improve documentation

---
 FakeYou.NET/Client/IFakeYouClient.cs | 9 ++++++---
 FakeYou.NET/FakeYou.NET.csproj       | 4 ++--
 2 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/FakeYou.NET/Client/IFakeYouClient.cs b/FakeYou.NET/Client/IFakeYouClient.cs
index bb15eb7..9ac1060 100644
--- a/FakeYou.NET/Client/IFakeYouClient.cs
+++ b/FakeYou.NET/Client/IFakeYouClient.cs
@@ -14,12 +14,15 @@ public interface IFakeYouClient : IDisposable
         event Action<FakeYouProgress>? OnProgress;
 
         /// <summary>
-        /// Generates audio from text using the specified voice model
+        /// Generates audio from text using the specified voice model.
         /// </summary>
         /// <param name="modelToken">The FakeYou model token (e.g., TM:1234)</param>
         /// <param name="text">The text to convert to speech</param>
-        /// <param name="cancellationToken">Optional cancellation token</param>
-        /// <returns>The generated audio data as a byte array</returns>
+        /// <returns>
+        /// WAV audio data as received from FakeYou API (44.1 kHz, stereo, 8-bit PCM).
+        /// Most modern applications expect 16-bit PCM, so format conversion may be 
+        /// required using audio processing libraries like NAudio.
+        /// </returns>
         Task<byte[]> GenerateAudioAsync(string modelToken, string text, CancellationToken cancellationToken = default);
         
         /// <summary>
diff --git a/FakeYou.NET/FakeYou.NET.csproj b/FakeYou.NET/FakeYou.NET.csproj
index e1f76cc..17b3433 100644
--- a/FakeYou.NET/FakeYou.NET.csproj
+++ b/FakeYou.NET/FakeYou.NET.csproj
@@ -8,10 +8,10 @@
         <!-- Package Info -->
         <PackageId>FakeYou.NET</PackageId>
         <Title>FakeYou.NET</Title>
-        <Version>2.2.0</Version>
+        <Version>2.2.1</Version>
         <Authors>Dan Clipca</Authors>
         <Company>Sponge Engine</Company>
-        <Description>A modern .NET client library for the FakeYou text-to-speech API</Description>
+        <Description>A modern .NET client library for the FakeYou text-to-speech API.</Description>
 
         <!-- Package Details -->
         <PackageTags>tts;speech;fakeyou;text-to-speech;voice;audio</PackageTags>