From 18be3b8a67f9ba253035e7da98acab1c527092e2 Mon Sep 17 00:00:00 2001
From: Johnny Huynh <27847622+johnnyhuy@users.noreply.github.com>
Date: Sun, 7 Apr 2024 12:59:37 +1000
Subject: [PATCH] chore: Improve project metadata and documentation.

- Update project description in `setup.py`
- Remove unnecessary comments in `install_requires` in `setup.py`
- Remove a mermaid graph from README.md
- Clarify purpose of `max_tokens` setting in configuration
- Update example configuration file in README.md
---
 README.md | 18 ++----------------
 setup.py  |  5 +----
 2 files changed, 3 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 3196f05..e5486c5 100644
--- a/README.md
+++ b/README.md
@@ -70,21 +70,6 @@ The Transcribe Me application follows a straightforward workflow:
    make install-cli
    ```
 
-```mermaid
-graph TD
-   A[Clone Repository] --> B[Install ASDF and Homebrew]
-   B --> C[Install Python and FFmpeg]
-   C --> D[Install Python Dependencies]
-   D --> E[Configure API Keys]
-   E --> F[Place Audio Files]
-   F --> G[Run Application]
-
-   A --> D
-   D --> E
-   E --> F
-   F --> G
-```
-
 ## :wrench: Usage
 
 1. Place your audio files in the `input` directory (or any other directory specified in the configuration).
@@ -104,6 +89,8 @@ graph TD
 
 The application uses a configuration file (`.transcribe.yaml`) to specify settings such as input/output directories, API keys, models, and their configurations. The configuration file is created automatically when you run the `transcribe-me install` command.
 
+> `max_tokens` is the maximum number of tokens to generate in the summary. The default is dynamic based on the model.
+
 Here is an example configuration file:
 
 ```yaml
@@ -117,7 +104,6 @@ openai:
 anthropic:
   models:
     - temperature: 0.8
-      max_tokens: 2048
       model: claude-3-sonnet-20240229
       system_prompt: Generate something creative and interesting, use Markdown, be a concise tech expert but kind to non-technical readers.
 
diff --git a/setup.py b/setup.py
index f98ceaa..5b4d303 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='transcribe_me',
-    description='A tool for transcribing audio files using the OpenAI Whisper API.',
+    description='A CLI tool to transcribe audio files using OpenAI API',
     version='0.1.0',
     packages=find_packages(),
     entry_points={
@@ -11,11 +11,8 @@
         ],
     },
     install_requires=[
-        # List your project's dependencies here
         'openai',
         'anthropic',
         'pydub',
-        'tqdm',
-        # ...
     ],
 )
\ No newline at end of file