From 45945732c955157071b63f4a94f4c779d31e6f46 Mon Sep 17 00:00:00 2001
From: Akbar Rahman <hi@alv.cx>
Date: Fri, 26 Jan 2024 01:44:51 +0000
Subject: [PATCH] update readme

---
 docker-compose.example.yml | 32 --------------------------------
 readme.md                  | 16 ++++++++++++++++
 2 files changed, 16 insertions(+), 32 deletions(-)
 delete mode 100644 docker-compose.example.yml
 create mode 100644 readme.md

diff --git a/docker-compose.example.yml b/docker-compose.example.yml
deleted file mode 100644
index e217ac5..0000000
--- a/docker-compose.example.yml
+++ /dev/null
@@ -1,32 +0,0 @@
-version: '3.9'
-
-services:
-  web:
-    hostname: heartbeats-web
-    build: 
-      context: .
-      dockerfile: ./web/Dockerfile
-    restart: unless-stopped
-    ports:
-      - 8464:80
-    environment:
-      - CLIENT_ID=${CLIENT_ID}
-      - CLIENT_SECRET=${CLIENT_SECRET}
-      - BASE_URL=http://localhost:8464
-
-  redis:
-    hostname: heartbeats-redis
-    image: redis
-    restart: unless-stopped
-    volumes:
-      - './redis-data:/data'
-
-  populater:
-    hostname: heartbeats-populater
-    build: 
-      context: .
-      dockerfile: ./populater/Dockerfile
-    restart: unless-stopped
-    environment:
-      - CLIENT_ID=${CLIENT_ID}
-      - CLIENT_SECRET=${CLIENT_SECRET}
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1d71af7
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,16 @@
+# :musical_note: heartbeats :saxophone:
+
+> Maintain a (potentially) public list of your recently liked songs so people know how cool you are
+
+
+# Setup
+
+0. Create a spotify developer account and create a new app
+0. Create a `.env` file with your spotify secrets:
+
+   ```
+   CLIENT_ID=<client_id>
+   CLIENT_SECRET=<client_secret>
+   ```
+   
+0. Run `docker compose up -d` to start