From d4876b253145469b64f25e60f08f5e32075d45cc Mon Sep 17 00:00:00 2001
From: Kira <cesium@cesium.one>
Date: Tue, 10 Mar 2026 21:15:27 -0400
Subject: [PATCH] better readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ad11c66..4d5b743 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
 # girl cock inator
 
-its docker compose, copy the default to `docker-compose.yml` and put a discord token in and start the container and it works i hope
\ No newline at end of file
+it finds twitter links and turns them into girlcock links for better embed
+
+## easiest way
+
+docker image published at `git.cesium.one/kira/cockinator:latest` only needs `DISCORD` passed as a variable with your token
+
+### examples
+
+`docker run -e "DISCORD=TOKEN_HERE" git.cesium.one/kira/cockinator:latest`
+
+```yml
+services:
+  bot:
+    restart: unless-stopped
+    image: git.cesium.one/kira/cockinator
+    environment:
+      - DISCORD=TOKEN_HERE
+```
+
+## easy way
+
+this also works in not docker with regular node.js, and pass it the `DISCORD` variable however you like
+
+`npm i && DISCORD=TOKEN_HERE node index.js`
+
+## other ways
+
+you can build the image yourself with `docker build . -t cockinator` to then run with `docker run cockinator`
+
+you can also build the image with docker-compose, by replacing `image: git.cesium.one/kira/cockinator` with `build: .`
+
+## the config file
+
+for the full functionality of the bot, you can copy `config.json.default` to `config.json` and fill it in.
+
+it'll need to be in the main directory, and for docker that means mounting it as a volume with `-v ./config.json:/app/config.json`
+
+## profile picture rotation
+
+it'll take everything in ./avatars and shuffle them before rotating through them. this can also be mounted for docker with `-v ./avatars:/app/avatars`