diff --git a/README.md b/README.md index 2789754..7870ee7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ YouTube Summarizer is a Streamlit-based web application that allows users to generate summaries of YouTube videos using AI-powered language models. +![Screenshot](screenshot.png) + ## Features - Fetch and cache YouTube video transcripts @@ -12,12 +14,14 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen ## Installation 1. Clone the repository: + ``` git clone https://github.com/yourusername/youtube-summarizer.git cd youtube-summarizer ``` 2. Install the required dependencies: + ``` pip install -r requirements.txt ``` @@ -32,6 +36,7 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen ## Usage 1. Run the Streamlit app: + ``` streamlit run src/main.py ``` @@ -52,7 +57,6 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen - YouTube Data API - Python-dotenv - ## Project Structure - `src/main.py`: Main Streamlit application @@ -70,4 +74,4 @@ WTFPL License ## Credits -Icon: "https://www.flaticon.com/free-icons/subtitles" by Freepik - Flaticon \ No newline at end of file +Icon: "https://www.flaticon.com/free-icons/subtitles" by Freepik - Flaticon diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..a17d6f1 Binary files /dev/null and b/screenshot.png differ