From d0c97d5efad969fa23127c3984d9db223f3db0bf Mon Sep 17 00:00:00 2001
From: trinkey <trinkey@duck.com>
Date: Thu, 27 Mar 2025 13:32:24 -0400
Subject: [PATCH] add more info to readme + example config

---
 README.md                        | 6 ++++++
 config.php => config.example.php | 2 +-
 2 files changed, 7 insertions(+), 1 deletion(-)
 rename config.php => config.example.php (97%)

diff --git a/README.md b/README.md
index eb393d3..e99aff5 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,9 @@
 a todo list manager but in php so it sucks
 
 https://todo.trinkey.com
+
+## how to run
+- make sure php and postgres are installed
+- setup your config file (`cp config.example.php config.php` then edit it to your needs)
+- create the database run `php setup.php` to setup the database
+- setup your server however you do it (ex. `php -S localhost:8000` for testing)
diff --git a/config.php b/config.example.php
similarity index 97%
rename from config.php
rename to config.example.php
index a66f99d..4246af9 100644
--- a/config.php
+++ b/config.example.php
@@ -5,7 +5,7 @@ $site_name = "Todo List Manager";
 $signups = "invite"; // true, false, "invite" - treats it as true if no users currently exist, invite requires an admin to invite the user
 $language = "en-US"; // an item from the lang folder. exclude the ".json"
 
-$admin_users = array("trinkey"
+$admin_users = array(
   // "username1", "username2", ...
 );