From c71ef3a8ef89d51b04e24191d77ddd3bd3e837c6 Mon Sep 17 00:00:00 2001
From: dexx <lenelena122@gmail.com>
Date: Fri, 5 Jun 2026 02:52:50 +0300
Subject: [PATCH] create readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee389e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# pozor
+
+Dark-only Next.js shame board powered by images from a GitHub repository.
+
+## What it does
+
+- Loads image files from a public GitHub repository through the GitHub Contents API.
+- Shows the images as a dark evidence-board style gallery.
+- Lets the user enter a repository, folder, and branch from the page.
+- Shows an honest empty state when no source is configured or no images are found.
+
+## Local development
+
+```bash
+bun install
+bun run dev
+```
+
+Then open `http://localhost:3000`.
+
+## Optional source configuration
+
+The board can also be preconfigured with environment variables:
+
+```bash
+NEXT_PUBLIC_GITHUB_REPO=owner/repository
+NEXT_PUBLIC_GITHUB_PHOTOS_PATH=path/to/images
+NEXT_PUBLIC_GITHUB_BRANCH=main
+```
+
+If these values are not set, the page starts empty and waits for a real GitHub source to be entered.
+
+## Build
+
+```bash
+bun run build
+```