From fa9c01c8d1dea156ac4323f0406e00730d424909 Mon Sep 17 00:00:00 2001
From: hex <hex@punk.lgbt>
Date: Sat, 18 Jan 2025 17:35:49 -0800
Subject: [PATCH] Updated README

---
 README.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 115 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 66778e1..7ef190f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,115 @@
-# ButterGarden
-Personal Recipe Database
+# 🧁 Butter Garden
+
+A delightful recipe management application built with Flask, featuring a cozy, warm-toned interface and modern web technologies.
+
+## ✨ Features
+
+- 🔍 Browse and search recipes
+- 📝 View detailed recipe ingredients and instructions
+- 👤 Admin interface for managing recipes
+- 🎨 Beautiful, responsive design with custom styling
+- 🚀 Modern interactions using HTMX
+- 🌙 Warm, inviting color scheme
+
+## 🛠️ Technology Stack
+
+- **Backend**: Flask + SQLAlchemy
+- **Frontend**: HTMX + Custom CSS
+- **Database**: SQLite
+- **Authentication**: Flask-Login
+- **Styling**: CSS Variables + Modern CSS Features
+
+## 🚀 Getting Started
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/butter-garden.git
+   cd butter-garden
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. Set up your environment variables:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your preferred settings
+   ```
+
+5. Initialize the database:
+   ```bash
+   python init_db.py
+   ```
+
+6. Run the application:
+   ```bash
+   flask run
+   ```
+
+Visit `http://localhost:5000` to start using Butter Garden!
+
+## 🔒 Environment Variables
+
+Create a `.env` file with the following variables:
+```
+FLASK_SECRET_KEY=your-secret-key-here
+ADMIN_USERNAME=your-admin-username
+ADMIN_PASSWORD=your-secure-password
+FLASK_ENV=development
+```
+
+## 👩‍💻 Development
+
+The application uses modern CSS features and HTMX for enhanced interactivity:
+
+- CSS Variables for easy theme customization
+- Responsive design with mobile-first approach
+- HTMX for dynamic content updates
+- Custom scrollbar styling
+- Sticky navigation elements
+
+## 🎨 Customization
+
+The app's appearance can be easily customized by modifying the CSS variables in `static/css/main.css`:
+
+```css
+:root {
+  --primary-color: #9B4819;     /* Warm terracotta */
+  --secondary-color: #D68C45;   /* Muted orange */
+  --background-color: #FDF6EC;  /* Warm off-white */
+  /* ... other variables ... */
+}
+```
+
+## 📱 Responsive Design
+
+- Desktop: Left sidebar navigation
+- Mobile: Top navigation bar
+- Adaptive recipe content display
+- Optimized spacing and typography
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature-name`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin feature-name`
+5. Submit a pull request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## 🌟 Acknowledgments
+
+- Font: "Sour Gummy" for that perfect whimsical touch
+- Color palette inspired by warm, inviting kitchen spaces
+- HTMX for making dynamic interactions a breeze