doc: updated readme

Author: therohitdas

readme.md

@@ -1,5 +1,6 @@
 # YouTube Transcript Generator
-[![Open in Collab](https://img.shields.io/badge/Open_in_Collab-555?style=for-the-badge&logo=googlecolab&labelColor=gray&color=purple)](https://colab.research.google.com/github/therohitdas/Youtube-Transcript-Generator/blob/main/main.ipynb)
+
+[![Open in Colab](https://img.shields.io/badge/Open_in_Colab-555?style=for-the-badge&logo=googlecolab&labelColor=gray&color=purple)](https://colab.research.google.com/github/therohitdas/Youtube-Transcript-Generator/blob/main/main.ipynb)
 ![GitHub License](https://img.shields.io/github/license/therohitdas/Youtube-Transcript-Generator?style=for-the-badge&color=blue) ![GitHub Repo stars](https://img.shields.io/github/stars/therohitdas/Youtube-Transcript-Generator?style=for-the-badge&logo=github)
 [![CodeFactor](https://www.codefactor.io/repository/github/therohitdas/youtube-transcript-generator/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/therohitdas/youtube-transcript-generator)
 
@@ -10,6 +11,7 @@ The YouTube Transcript Generator is a powerful tool designed to streamline the p
 ### How It Can Help 🚀
 
 This tool is particularly useful for:
+
 - **Note Taking:** Quickly convert YouTube videos into text format for easy note-taking.
 - **Content Analysis:** Analyze and derive insights from video content by converting it into text data.
 - **Chat Bot Training:** Use the generated transcripts to train chatbots, such as ChatGPT, for natural language understanding.
@@ -26,47 +28,57 @@ This tool is particularly useful for:
 
 ## Environment Variables 🌐
 
-- `GOOGLE_API_KEY`: Set up your Google API key for video information retrieval. You will need to create a Project in the Google Cloud for this and enable the YouTube v3 API. This is optional, if you don't add it, the chapters will not be added.
+- `YOUTUBE_API_KEY`: Set up your Google API key for video information retrieval. You will need to create a Project in the Google Cloud for this and enable the YouTube v3 API. This is optional, if you don't add it, the chapters will not be added.
 
 ## Script Parameters 📜
+
 When running the script locally, you can pass these parameters to the script:
 
 ### Positional Argument:
+
 - `url`: YouTube video URL
 
 ### Optional Arguments:
+
 - `-h, --help`: Show the help message and exit
 - `-l LANGUAGE, --language LANGUAGE`: Language for the transcript (default: en)
 - `-p, --punctuated`: Generate punctuated transcript (default: False)
-- `-o OUTPUT_DIR, --output_dir OUTPUT_DIR`: Output directory for saving the transcript (default: .)
+- `-o OUTPUT_DIR, --output_dir OUTPUT_DIR`: Output directory for saving the transcript (default: current directory)
 - `-f FILENAME, --filename FILENAME`: Filename for saving the transcript (default: Video Title or Video Id)
 - `-m PUNCTUATION_MODEL, --punctuation_model PUNCTUATION_MODEL`: Path to the punctuation model (default: None)
 - `-v, --verbose`: Print verbose output (default: False)
 
-## Run in Google Collab 🚀
+## Run in Google Colab 🚀
+
 To run this project in Google Colab, follow these steps:
-1. Open the [Google Colab notebook](https://colab.research.google.com/github/therohitdas/Youtube-Transcript-Generator/blob/main/main.ipynb).
-2. Add Google's Project API key to the secrets tab under this key: `GOOGLE_API_KEY` and toggle notebook access to on.
-3. Edit the variables in the second last cell.
-4. Go to Runtime > Change Runtime Type and select any GPU type. If you use CPU, the output for punctuated transcript will take some minutes to complete (around 1 minute per 10-minute video)
-5. Change the values in the third last cell to include your URL etc.
+
+1. Open the [Google Colab Notebook](https://colab.research.google.com/github/therohitdas/Youtube-Transcript-Generator/blob/main/main.ipynb).
+2. Add Google's Project API key to the secrets tab under this key: `YOUTUBE_API_KEY` and toggle notebook access to on.
+3. Go to Runtime > Change Runtime Type and select T4 GPU type. If you use CPU, the output for punctuated transcript will take some minutes to complete (around 1 minute per 10-minute video)
+4. Change the values in the second cell to include your URL etc.
+5. Press CTRL+F9 or CMD+F9 to run the notebook.
 
 ## Run Locally 💻
 
 I do not recommend running locally as it will download tensors and other stuff which are over 6gb. But if you want you can do this:
+
 1. Clone the repository: `git clone https://github.com/therohitdas/Youtube-Transcript-Generator.git`
-2. Install dependencies: `pip install youtube-transcript-api deepmultilingualpunctuation nltk google-api-python-client google-auth-oauthlib`
-3. Set up the required environment variables: `GOOGLE_API_KEY` (optional).
-4. Run the script: `python index.py <YouTube_URL>` or `python index.py -h` for the help menu.
+2. Create a virtual environment: `python -m venv venv`
+3. Activate the virtual environment: `source venv/bin/activate` (Linux/MacOS) or `venv\Scripts\activate` (Windows)
+4. Install dependencies: `pip install -r requirements.txt`
+5. Set up the required environment variables: `YOUTUBE_API_KEY` (optional). You can either create a `.env` file or set them up in your system using.
+6. Run the script: `python index.py <YouTube_URL>` or `python index.py -h` for the help menu.
 
 ## Support 🤝
 
 For any issues or feature requests, please [create an issue](https://github.com/therohitdas/Youtube-Transcript-Generator/issues).
 
 ## Example 📋
+
 Here's an example of how to run the script with various options:
 
 ### Basic Usage
+
 ```bash
 python index.py https://www.youtube.com/watch?v=VIDEO_ID
 ```
@@ -112,19 +124,23 @@ python index.py https://www.youtube.com/watch?v=VIDEO_ID -v
 ```bash
 python index.py https://www.youtube.com/watch?v=VIDEO_ID -m author/model_name
 ```
+
 Punctuation model name can be taken from [here](https://huggingface.co/oliverguhr/fullstop-punctuation-multilang-large#languages).
 
 Make sure to replace `https://www.youtube.com/watch?v=VIDEO_ID` with the actual URL of the YouTube video you want to process.
 
 Feel free to copy and paste these examples into your terminal.
+
 ## Acknowledgments 🙌
 
 This script utilizes the [youtube-transcript-api](https://github.com/jdepoix/youtube-transcript-api) and [fullstop-punctuation-multilang-large](https://huggingface.co/oliverguhr/fullstop-punctuation-multilang-large) libraries. Special thanks to their contributors.
 
 Feel free to adapt and use the script based on your requirements. Enjoy the convenience of YouTube transcript processing!
 
 ## Connect with me 📧
+
 The best way to connect is to email me [[email protected]](mailto:[email protected])
+
 - [x/therohitdas](https://x.com/therohitdas)
 - [GitHub/therohitdas](https://github.com/therohitdas)