From e89baa7a979c05f05ab831f036cddc38afabf848 Mon Sep 17 00:00:00 2001
From: Scott Korvek <admin@korvek.com>
Date: Mon, 10 Nov 2025 15:15:34 +0000
Subject: [PATCH] first commit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b78fa58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+### Event Directory
+
+Directory of local events for member businesses
+
+### Installation
+
+You can install this app using the [bench](https://github.com/frappe/bench) CLI:
+
+```bash
+cd $PATH_TO_YOUR_BENCH
+bench get-app $URL_OF_THIS_REPO --branch develop
+bench install-app event_directory
+```
+
+### Contributing
+
+This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository:
+
+```bash
+cd apps/event_directory
+pre-commit install
+```
+
+Pre-commit is configured to use the following tools for checking and formatting your code:
+
+- ruff
+- eslint
+- prettier
+- pyupgrade
+
+### License
+
+mit