Merge branch 'main' of https://github.com/raahilv/Vid2Notes

Author: NlSEMONO

README.md

@@ -1 +1,62 @@
-this is readme
+*ENTER W README*
+
+## Vid2Notes
+
+Never watch a lecture video again.
+
+![Vid2Notes Meme](https://github.com/raahilv/Vid2Notes/assets/81647774/4ce48742-6373-4d07-af92-84c217ba7fd7)
+
+---
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Demo](#demo)
+- [Acknowledgements](#Acknowledgements)
+
+---
+
+## Introduction
+
+Welcome to Vid2Notes, and welcome to never having to watch a MAT137 pre-class video ever again. 🔥
+
+Paste any Youtube video link into our tool and get a detailed summary in bullet form about that video. 
+Also take adavnatage of the Flash Cards function which allows you to study that topic in a fun and effective way.
+
+This tool is very useful for users who have hearing disabilities as it allows them to read the video summary.
+Also perfect for students who hate watching lecture videos and need a quick and effective way to learn the material.
+
+---
+
+## Features
+
+List the key features of your project. You can use checkboxes to indicate the completion status of each feature.
+
+Feature 1: Video Summary in Point Form
+ - Like mentioned before, this feature takes a youtube link as input and outputs a detailed summary of that video in point form with the use of Generative AI APIs.
+ - Videos of any lengths are accepted.
+ - The video must be a *Youtube* video.
+  
+Feature 2: Study Flash Cards
+ - Once the user has used Feature 1, they have the option to study/memorize the material using Flash Cards.
+ - A question is asked about the topic and to see the answer the user simply needs to click the card to unveil it.
+   
+---
+
+## Demo
+
+Link to a live demo on how to use Vid2Notes
+
+[Live Demo](https://www.youtube.com/watch?v=Ln7522u1Z4g)
+
+## Acknowledgments
+
+Created with the help of:
+
+ - Python
+ - JavaScript
+ - CSS
+ - YoutubeAPI
+ - CohereAPI
+ - MAT137 trauma 😔