create readme

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
+```