From 95a292a7f69f130107c0d9be7b3fe29319da73bb Mon Sep 17 00:00:00 2001
From: Germaine Brown <g@germainebrown.com>
Date: Sun, 9 Aug 2026 23:47:10 -0400
Subject: [PATCH] docs: replace stub README, add proper README and CHANGELOG
 per itpp-standards template

- Rewrote README.md following itpp-standards Section 2.1 template
- Updated CHANGELOG.md to standard format
- Added .gitea/workflows/docs-check.yml for docs CI
---
 .gitea/workflows/docs-check.yml | 26 ++++++++++++++++++++++++++
 CHANGELOG.md                    | 16 +++++++++-------
 README.md                       | 33 +++++++++++++++++++++++++++++++--
 3 files changed, 66 insertions(+), 9 deletions(-)
 create mode 100644 .gitea/workflows/docs-check.yml

diff --git a/.gitea/workflows/docs-check.yml b/.gitea/workflows/docs-check.yml
new file mode 100644
index 0000000..17dc263
--- /dev/null
+++ b/.gitea/workflows/docs-check.yml
@@ -0,0 +1,26 @@
+name: Docs Check
+on:
+  push:
+    paths:
+      - '**.md'
+      - 'docs/**'
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Markdown lint
+        run: |
+          npm install -g markdownlint-cli
+          markdownlint '**/*.md' --ignore node_modules
+      - name: Link check
+        run: |
+          npm install -g markdown-link-check
+          find . -name '*.md' -not -path '*/node_modules/*' \
+            -exec markdown-link-check {} \;
+      - name: Spell check
+        run: |
+          pip install codespell
+          codespell '**/*.md' --skip='*.git*'
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ce93d7e..34bdf59 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,11 +1,13 @@
-# Changelog - OSINT People Search
+# OSINT People Search — CHANGELOG
 
-### 2026-07-10
-- **Documentation:** Migrated web scraping API comparison and tool evaluations.
+## 2026-07-10 — Documentation
 
-### 2026-07-02
-- **Research:** Completed comparison of web scraping APIs for OSINT data collection.
+- Migrated web scraping API comparison and tool evaluations into the repo.
 
-### 2026-06-20
-- **API:** Drafted initial frontend UI and API integration plans.
+## 2026-07-02 — Research
 
+- Completed comparison of web scraping APIs for OSINT data collection.
+
+## 2026-06-20 — API Planning
+
+- Drafted initial frontend UI and API integration plans.
diff --git a/README.md b/README.md
index 1e2b1e3..9d1ac77 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
-# osint-tool
+# OSINT People Search
 
-Project directory. See CHANGELOG.md for development history.
+> **Owner:** Germaine | **Status:** PLANNED
+> **Last Updated:** 2026-08-09
+
+An open-source intelligence (OSINT) toolchain for people search, skip tracing, and data aggregation. Integrates multiple web scraping and search APIs to build comprehensive person profiles from public data sources — supporting debt recovery, asset location, and investigative workflows.
+
+## What's Inside
+
+- `research/` — API evaluations and tool comparisons for web scraping, search, and browser automation
+  - `web-scraping-api-comparison.md` — Detailed comparison of 10 APIs (Firecrawl, ScrapingAnt, SerpAPI, Browserbase, etc.) for scraping government sites, court records, and people-search platforms
+
+## Tech Stack
+
+- **Scraping Pipeline:** Firecrawl, ScrapingAnt, Browserbase (evaluated, pending selection)
+- **Search:** Brave Search API, Serper, Tavily (evaluated)
+- **Backend:** TBD — likely Python/FastAPI
+- **Frontend:** TBD
+
+## Quick Start
+
+```bash
+git clone https://git.itpropartner.com/ippadmin/osint-tool.git
+cd osint-tool
+# Review research/ for API evaluation and selection
+```
+
+## Related
+
+- [itpp-infrastructure](https://git.itpropartner.com/ippadmin/itpp-infrastructure) — server inventory, DNS
+- [itpp-standards](https://git.itpropartner.com/ippadmin/itpp-standards) — docs standards and templates
+- [FleetTracker360](https://git.itpropartner.com/ippadmin/fleettracker360) — GPS fleet tracking