Add demo screenshot, Bun prerequisite, and fix banner alignment

- Embed metadata-scrubbed terminal demo (assets/demo.png) in Quick Start
- Document Bun install with one-liners and a no-install escape hatch
  to the copy-paste template; correct the "no installation" claim
- Fix off-by-one banner borders in both scripts (all now 64 cols)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
rpriven 2026-07-10 14:33:39 -06:00
parent 022e61ba3e
commit 50fb20646a
Signed by: djedi
GPG key ID: D04DED574622EF45
4 changed files with 19 additions and 5 deletions

View file

@ -8,8 +8,22 @@ Government surveillance systems should be transparent and accountable to the com
## ⚡ Quick Start ## ⚡ 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) ### 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 ```bash
# Clone the repository # Clone the repository
git clone https://github.com/rpriven/flock-public-records-toolkit 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) ⚡ **`lookup-state-law.ts`** (Quick Reference) ⚡
- Instant state statute lookup - Instant state statute lookup
- Shows correct legal citations for your state - 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 <STATE_CODE>` - Usage: `bun lookup-state-law.ts <STATE_CODE>`
**`generate-flock-request.ts`** (Interactive Generator) 🔒 **`generate-flock-request.ts`** (Interactive Generator) 🔒

BIN
assets/demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

View file

@ -269,8 +269,8 @@ function getCurrentDate(): string {
// Main interactive function // Main interactive function
async function main() { async function main() {
console.log("╔══════════════════════════════════════════════════════════════╗"); console.log("╔══════════════════════════════════════════════════════════════╗");
console.log("║ Flock Safety Public Records Request Generator ║"); console.log("║ Flock Safety Public Records Request Generator ║");
console.log("║ Generates state-specific public records requests ║"); console.log("║ Generates state-specific public records requests ║");
console.log("║ (Security Hardened Version) ║"); console.log("║ (Security Hardened Version) ║");
console.log("╚══════════════════════════════════════════════════════════════╝\n"); console.log("╚══════════════════════════════════════════════════════════════╝\n");

View file

@ -177,7 +177,7 @@ const args = process.argv.slice(2);
if (args.length === 0) { if (args.length === 0) {
console.log("╔══════════════════════════════════════════════════════════════╗"); console.log("╔══════════════════════════════════════════════════════════════╗");
console.log("║ State Public Records Law Quick Reference ║"); console.log("║ State Public Records Law Quick Reference ║");
console.log("╚══════════════════════════════════════════════════════════════╝\n"); console.log("╚══════════════════════════════════════════════════════════════╝\n");
console.log("Usage: bun lookup-state-law.ts <STATE_CODE>\n"); console.log("Usage: bun lookup-state-law.ts <STATE_CODE>\n");
console.log("Example: bun lookup-state-law.ts CO\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]; const law = STATE_LAWS[stateCode as keyof typeof STATE_LAWS];
console.log("\n╔══════════════════════════════════════════════════════════════╗"); console.log("\n╔══════════════════════════════════════════════════════════════╗");
console.log(`${law.name.padEnd(58)} `); console.log(`${law.name.padEnd(60)}`);
console.log("╚══════════════════════════════════════════════════════════════╝\n"); console.log("╚══════════════════════════════════════════════════════════════╝\n");
console.log("📖 Official Law Name:"); console.log("📖 Official Law Name:");