Add license, GHA, update readme

Author: DouweM

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --group dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+
+  pyright:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv sync --group dev
+      - run: uv run pyright

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pydantic Services, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
 # Braindump
 
-Extract coding rules from PR review comments and generate AGENTS.md files for any GitHub repository.
+Extract coding rules from PR review comments and generate `AGENTS.md` files for any GitHub repository.
 
 ## How it works
 
@@ -26,6 +26,8 @@ Each stage is resumable — if interrupted, it picks up from where it left off.
 
 ## Setup
 
+The `braindump` CLI is not currently published on PyPI, so the first step is to clone this repo locally. Then run:
+
 ```bash
 # Install dependencies
 uv sync
@@ -52,6 +54,10 @@ export BRAINDUMP_REPO=pydantic/pydantic-ai
 uv run braindump run --since 2025-10-01
 ```
 
+Note that this project is 100% vibecoded, and the pipeline and thresholds have been optimized for the [`pydantic-ai`](https://github.com/pydantic/pydantic-ai) repo primarily. 
+If the pipeline generates unexpected rules for your repo, whether invalid or duplicate or otherwise unhelpful, you're encouraged to tell Claude (or your coding agent of choice) to investigate the issue (by referring to the generated rule IDs) and make changes to the pipeline until it does what you want.
+It's fine and expected if different teams use their own fork of `braindump` that evolves over time to meet their needs: there's no expectation that the version in this repo will work for absolutely everyone, so you don't need to upstream changes unless you beleive they are strictly better for every user than what came before.
+
 ## Commands
 
 All stages support `--concurrency N` to control parallel LLM/API requests and `--fresh` to wipe previous outputs before running.