Skip to content

docs: add enterprise README with architecture, API reference, and badges#1

Closed
Taas-ai wants to merge 1 commit intomainfrom
docs/enterprise-readme
Closed

docs: add enterprise README with architecture, API reference, and badges#1
Taas-ai wants to merge 1 commit intomainfrom
docs/enterprise-readme

Conversation

@Taas-ai
Copy link
Collaborator

@Taas-ai Taas-ai commented Feb 12, 2026

Summary

  • Adds a comprehensive enterprise-grade README.md to replace the missing project documentation
  • Includes CI badge, license badge, Node/TypeScript/PQC version badges
  • Covers architecture diagram (ASCII), quick start, project structure, full API reference, security section, and contributing guidelines links

Details

This is the first step in the enterprise GitHub governance upgrade. The README includes:

  • Header: Logo, title, description, and 6 status badges (CI, license, Node, TypeScript, PQC, tests)
  • Overview: Key capabilities (PQC, Tokenized KYC, Offline CBDC, Biometric MFA, Smart Wallet, AI Anomaly Detection)
  • Architecture: ASCII diagram showing Client (React 19) → Server (Express) → PostgreSQL stack
  • Quick Start: Prerequisites table, dev/test/build/Docker commands
  • Project Structure: Full directory tree with annotations
  • API Reference: 13 endpoints documented in table format
  • Security: Cryptographic standards (FIPS 203/204), links to SECURITY.md
  • License: Business Source License 1.1 with Apache 2.0 change date (2030)

Next Steps

Follow-up PRs will add remaining enterprise governance files:

  • LICENSE, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md
  • CODEOWNERS, .editorconfig, .nvmrc, CHANGELOG.md
  • .github/ISSUE_TEMPLATE/, .github/PULL_REQUEST_TEMPLATE.md, .github/dependabot.yml
  • CI/CD workflow upgrade (caching, matrix builds, Docker verification)

Note

Low Risk
Documentation-only change; no code, runtime, or security behavior is modified.

Overview
Adds a new top-level README.md (previously missing) to provide enterprise-style project documentation.

The README introduces badges (CI/license/runtime/test status), an overview of key capabilities, an ASCII architecture diagram, quick-start commands (dev/test/build/Docker), a project structure tree, an API reference table of endpoints, and links to SECURITY.md, CONTRIBUTING.md, and LICENSE with BSL 1.1 change-date notes.

Written by Cursor Bugbot for commit e68cc0d. This will update automatically on new commits. Configure here.

@vercel
Copy link

vercel bot commented Feb 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
q-grid-in Ready Ready Preview, Comment Feb 12, 2026 9:45am

@Taas-ai Taas-ai closed this Feb 12, 2026
@Taas-ai Taas-ai deleted the docs/enterprise-readme branch February 12, 2026 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant