---
name: create-readme
description: Use this skill to create a concise, well-structured `README.md` file for the project. Review the repo first, then write clear GitHub-flavored documentation without unnecessary sections or filler.
---

## Task

Create or update a comprehensive but concise `README.md` after reviewing the entire project and workspace.

Ensure the README is appealing, informative, and easy to read.

Rules:

- Match Adam's README style first: structure, tone, formatting, and detail.
- Primary references: <https://raw.githubusercontent.com/adam01110/nixos/refs/heads/main/README.md>, <https://raw.githubusercontent.com/adam01110/nur/refs/heads/main/README.md>, <https://raw.githubusercontent.com/adam01110/nix-userstyles/refs/heads/main/README.md>.
- Optional inspiration only when useful: <https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md>, <https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md>, <https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md>, <https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md>.
- Keep it concise, GFM-formatted, and emoji-free.
- Skip `LICENSE`, `CONTRIBUTING`, `CHANGELOG`, and similar sections handled by dedicated files.
- Use GitHub admonitions when they improve clarity.
- Use a discovered logo/icon in the header when appropriate.
