Merge pull request #54 from adipai/readme_branch2

Readme branch2

.github/workflows/codecoverage.yml

@@ -1,11 +1,6 @@
 name: Code Coverage
 
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-  workflow_dispatch:
+on: [push]
 
 jobs:
   upload-coverage:

.github/workflows/unittest.yml

@@ -1,11 +1,6 @@
 name: Unittest
 
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-  workflow_dispatch:
+on: [push]
 
 jobs:
   build:

README.md

@@ -3,33 +3,61 @@
 
 PopcornPicks is more than just a movie recommender system; it's a gateway to a world of cinematic adventures. With an ever-expanding library of films and a powerful recommendation algorithm, PopcornPicks is here to transform the way you discover, enjoy, and connect with movies.
 
-### Overview
-PopcornPicks is a webapp where you can get movie recommedations based the movies you like
+## Goal
+PopcornPicks: Your movie recommender! Input movies, get tailored suggestions, and share via email. Elevate your movie choices effortlessly!
 
+## Documentation 📚
+Checkout for project documentation at - [here](https://github.com/adipai/PopcornPicks/wiki)
 
+## Project Presentation Video
+You can see the project presentation at - .
 
-### Tech stack 👨‍💻
-<img src = "https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white"> <img src = "https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white"> <img src = "https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white"> <img src = "https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white"> <img src = "https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E"> <img src = "https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white"> <img src = "https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">
+## Project Description
+PopcornPicks is a user-friendly movie recommender that curates a tailored list of 10 movie predictions based on user-provided movie preferences. Users can input their favorite movies, and our algorithm refines recommendations based on feedback—Liked, Disliked, or Yet To Watch. Additionally, PopcornPicks offers the convenience of emailing the recommended movies, enhancing the movie-watching experience.
 
-### Getting Started
+## Project 2 Delta
+Checkout the changes that we made for Project 2 [here](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup)
 
-1. Clone the repository from GitHub.
-2. Follow the setup instructions in the documentation.
-3. Start enjoying personalized movie recommendations!
+## Tech stack Used👨‍💻:
+
+<code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_html5/w3_html5-ar21.svg"></a></code>
+<code><a href="https://developer.mozilla.org/en-US/docs/Web/CSS" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_css/w3_css-ar21.svg"></a></code>
+<code><a href="https://www.python.org/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/python/python-horizontal.svg"></a></code>
+<code><a href="https://www.javascript.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/javascript/javascript-ar21.svg"></a></code>
+<code><a href="https://www.jquery.com//" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/jquery/jquery-horizontal.svg"></a></code>
+<code><a href="https://flask.palletsprojects.com/en/1.1.x/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/pocoo_flask/pocoo_flask-ar21.svg"></a></code>
+<code><a href="https://github.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/github/github-ar21.svg"></a></code>
+<!-- <code><a href="https://git-scm.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/git-scm/git-scm-ar21.svg"></a></code>
+<code><a href="https://github.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/github/github-ar21.svg"></a></code> -->
+<!-- <code><a href="https://code.visualstudio.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/visualstudio_code/visualstudio_code-ar21.svg"></a></code>
+<code><a href="https://www.python.org/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/python/python-ar21.svg"></a></code>-->
+
+<p align="center">
+<img src="https://i.giphy.com/media/LMt9638dO8dftAjtco/200.webp" width="150"> <img src="https://i.giphy.com/media/KzJkzjggfGN5Py6nkT/200.webp" width="150"><img src="https://i.giphy.com/media/IdyAQJVN2kVPNUrojM/200.webp" width="150"> <img src="https://media.giphy.com/media/UWt0rhp21JgLwoeFQP/giphy.gif" width ="150"/> <img src="https://media.giphy.com/media/kH6CqYiquZawmU1HI6/giphy.gif" width ="150"/> 
+</p>
 
-### Documentation 📚
-Refer to Wiki page [here](https://github.com/git-ankit/MovieRecommender/wiki/Documentation)
+## Getting Started
+
+1. Clone the repository from [GitHub](https://github.com/adipai/PopcornPicks).
+2. Follow the setup instructions in the [documentation](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup).
+3. Start enjoying personalized movie recommendations!
 
-### Bug? 🐛
-Raise a issue on this repository, we would love to look at it ❤️
+## Contact
+In case of any issues, please e-mail your queries to popcornpicks504@gmail.com or raise an issue on this repository.
 
-### Contributors
+## Contributions to the Project? 🐛
+Please refer to the [Contributing.md](https://github.com/adipai/PopcornPicks/blob/master/CONTRIBUTING.md) if you want to contribute to the PopcornPicks source code. Follow all the guidelines mentioned in the same and raise a pull request, we would love to look at it ❤️❤️!
 
+## Contributors
+Aditya Pai Brahmavar<br/>
+Ananya Mantravadi<br/>
+Rishi Singhal<br/>
+Samarth Shetty<br/>
 
-### Join the PopcornPicks Community:
+## Join the PopcornPicks Community:
 
 Contribute to the project and help us improve recommendations.
 Share your experience and film discoveries with us.
 Together, let's make PopcornPicks the ultimate movie companion!
 PopcornPicks is more than just code; it's a passion for cinema, and we invite you to be a part of this exciting journey. Start exploring, sharing, and discovering movies like never before with PopcornPicks !
-Let's make movie nights extraordinary together!
+Let's make movie nights extraordinary together!