From 536d5bdcd5d2da750275b8770054940049917a50 Mon Sep 17 00:00:00 2001
From: deepend-tildeclub <58404188+deepend-tildeclub@users.noreply.github.com>
Date: Sun, 3 Sep 2023 21:51:12 -0600
Subject: [PATCH] Create README.md

---
 guestbook/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 guestbook/README.md

diff --git a/guestbook/README.md b/guestbook/README.md
new file mode 100644
index 0000000..3ce251f
--- /dev/null
+++ b/guestbook/README.md
@@ -0,0 +1,24 @@
+# Geocities-inspired Guestbook
+
+A modern take on the classic Geocities guestbook, built with PHP and SQLite. This guestbook allows for multi-user functionality, user-specific themes, and adheres to current coding standards.
+
+## Features
+
+- **Multi-user Support**: Each user can have their own guestbook by simply accessing [https://tilde.club/guestbook/?user=username](https://tilde.club/guestbook/?user=username).
+- **Custom Themes**: Users can specify their own CSS theme by placing a `.css` file in their directory and specifying it with the `theme` parameter in the URL.
+- **Referrer Validation**: The guestbook checks the referrer to ensure that entries are being made from the correct user's page.
+- **SQLite Backend**: Uses SQLite for a lightweight and serverless database solution.
+
+## Customization
+
+### Themes
+
+Users can specify their own theme by placing a `.css` file in their directory. This theme can be applied by adding the `theme` parameter to the URL, e.g., [https://tilde.club/guestbook/?user=username&theme=cssname](https://tilde.club/guestbook/?user=username&theme=cssname).
+
+A default `dark.css` theme is provided in the repository as an example.
+
+### Adding Entries
+
+User need to link to the guestbook from their tilde page to https://tilde.club/guestbook/?user=username  or 
+https://tilde.club/guestbook/?user=username&theme=themecssname and then your viewers can
+simply fill out the form on your guestbook page and submit.