diff --git a/README.md b/README.md index 4d7de1b..f23f0a0 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,22 @@ Government surveillance systems should be transparent and accountable to the com ## ⚡ Quick Start +![Terminal output showing the Colorado public records law citation and ready-to-use request language](assets/demo.png) + ### For Tech-Savvy Users (Command Line) +The scripts run on [Bun](https://bun.sh), a free JavaScript/TypeScript runtime (it runs the `.ts` scripts directly, no build step) — one-line install: + +```bash +# macOS / Linux +curl -fsSL https://bun.sh/install | bash + +# Windows (PowerShell) +powershell -c "irm bun.sh/install.ps1 | iex" +``` + +**No Bun? No problem** — skip down to the [copy-paste template](#for-everyone-copy-paste-template) below; it requires nothing. + ```bash # Clone the repository git clone https://github.com/rpriven/flock-public-records-toolkit @@ -46,7 +60,7 @@ A browser-based version — **no download, no install**. Pick your state and fil **`lookup-state-law.ts`** (Quick Reference) ⚡ - Instant state statute lookup - Shows correct legal citations for your state -- No installation needed - just run it +- No dependencies — one command to run (requires Bun, see Quick Start) - Usage: `bun lookup-state-law.ts ` **`generate-flock-request.ts`** (Interactive Generator) 🔒 diff --git a/assets/demo.png b/assets/demo.png new file mode 100644 index 0000000..0c09f1c Binary files /dev/null and b/assets/demo.png differ diff --git a/generate-flock-request.ts b/generate-flock-request.ts index db30f05..a4baad6 100755 --- a/generate-flock-request.ts +++ b/generate-flock-request.ts @@ -269,8 +269,8 @@ function getCurrentDate(): string { // Main interactive function async function main() { console.log("╔══════════════════════════════════════════════════════════════╗"); - console.log("║ Flock Safety Public Records Request Generator ║"); - console.log("║ Generates state-specific public records requests ║"); + console.log("║ Flock Safety Public Records Request Generator ║"); + console.log("║ Generates state-specific public records requests ║"); console.log("║ (Security Hardened Version) ║"); console.log("╚══════════════════════════════════════════════════════════════╝\n"); diff --git a/lookup-state-law.ts b/lookup-state-law.ts index 85d4ec3..15f1e94 100755 --- a/lookup-state-law.ts +++ b/lookup-state-law.ts @@ -177,7 +177,7 @@ const args = process.argv.slice(2); if (args.length === 0) { console.log("╔══════════════════════════════════════════════════════════════╗"); - console.log("║ State Public Records Law Quick Reference ║"); + console.log("║ State Public Records Law Quick Reference ║"); console.log("╚══════════════════════════════════════════════════════════════╝\n"); console.log("Usage: bun lookup-state-law.ts \n"); console.log("Example: bun lookup-state-law.ts CO\n"); @@ -231,7 +231,7 @@ if (!STATE_LAWS[stateCode as keyof typeof STATE_LAWS]) { const law = STATE_LAWS[stateCode as keyof typeof STATE_LAWS]; console.log("\n╔══════════════════════════════════════════════════════════════╗"); -console.log(`║ ${law.name.padEnd(58)} ║`); +console.log(`║ ${law.name.padEnd(60)}║`); console.log("╚══════════════════════════════════════════════════════════════╝\n"); console.log("📖 Official Law Name:");