docs: update README.md and create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Want to contribute?
+
+First off, thanks for taking the time to contribute! 😇
+
+---
+
+### Bug report:
+
+Did you find a bug?
+
+- Open an issue with full bug description and example, and I'll see what I can do about it 🤠
+- If you can fix the bug you've found, consider making a PR, and I'll see if your fix fits 👀
+- Make sure that the PR or the issue clearly describes the problem and solution 👌
+
+---
+
+### New features:
+
+If you have a new idea or an improvement, consider making an issue fully describing it and why we should add it, and we'll see whether it fits or not 😇

README.md

@@ -1,6 +1,66 @@
-# dankmuzikk
+<div align="center">
+  <a href="https://dankmuzikk.com" target="_blank"><img src="https://dankmuzikk.com/static/android-chrome-512x512.png" width="150" /></a>
 
-[![rex-deploy](https://github.com/mbaraa/dankmuzikk/actions/workflows/rex-deploy.yml/badge.svg)](https://github.com/mbaraa/dankmuzikk/actions/workflows/rex-deploy.yml)
+  <h1>DankMuzikk</h1>
+  <p>
+    <strong>Create, Share and Play Music Playlists.</strong>
+  </p>
+  <p>
+    <a href="https://goreportcard.com/report/github.com/mbaraa/dankmuzikk"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/mbaraa/dankmuzikk"/></a>
+    <a href="https://github.com/mbaraa/dankmuzikk/actions/workflows/rex-deployment.yml"><img alt="rex-deployment" src="https://github.com/mbaraa/dankmuzikk/actions/workflows/rex-deployment.yml/badge.svg"/></a>
+  </p>
+</div>
 
+## About
 
-Create, Share and Play Music Playlists.
+**DankMuzikk** is a music player designed for colloborative playlists, where a playlist's collaborators can add and vote for music in a playlist, and the other music player stuff.
+
+_Note: this is a fling side-project that will die in a while so don't get your hopes up._
+
+## Contributing
+
+IDK, it would be really nice of you to contribute, check the poorly written [CONTRIBUTING.md](/CONTRIBUTING.md) for more info.
+
+### Roadmap
+
+- [x] Search YouTube for music
+- [x] Web UI
+- [x] Audio player
+- [x] Accounts and Profiles
+- [ ] Playlists
+- [ ] Vote songs in playlists
+- [ ] Write a better YouTube scraper (or try to fix the quota thing)
+- [ ]
+- [ ] Refactor the code (never gonna happen)
+
+## Run locally
+
+1. Clone the repo.
+
+```bash
+git clone https://github.com/mbaraa/dankmuzikk
+```
+
+2. Create the docker environment file
+
+```bash
+cp .env.example .env.docker
+```
+
+3. Run it with compose.
+
+```bash
+docker compose up
+```
+
+3. Visit http://localhost:20250
+4. Don't ask why I chose this weird port.
+
+## Acknowledgements
+
+- The background was taken from dankpods.net
+- Frank’s original image was taken from dankpods.biz
+- Colorscheme is inspired from [Dankpods](https://www.youtube.com/@DankPods)
+- templ was used to make this project’s views: MIT licensed by [Adrian Hesketh](https://github.com/a-h)
+- htmx was used to make this project’s client more dynamic: No licence but just wanted to say that I used htmx BTW
+- youtube-scrape was used to search videos without using the actual YouTube API (small quota): MIT licenses by [Herman Fassett](https://github.com/HermanFassett)