Skip to content

docs(readme): restyle in openfirma format with CI/License/Built-with badges#5

Merged
therandomsecurityguy merged 1 commit into
mainfrom
docs/readme-restyle
Jun 21, 2026
Merged

docs(readme): restyle in openfirma format with CI/License/Built-with badges#5
therandomsecurityguy merged 1 commit into
mainfrom
docs/readme-restyle

Conversation

@therandomsecurityguy

Copy link
Copy Markdown
Owner

Restructure the README around numbered sections (1. What is Khalifa, 2. Deploy Khalifa, 3. Architecture, 4. Repo structure, License) with anchor links, mirroring the look-and-feel of the openfirma README.

Changes

  • Add header layout: logo + tagline + docs/operations links strip
  • Add badges row: CI (GitHub Actions), License (BSD 3-Clause), Built with TypeScript + Node.js (shields.io)
  • Reorganize into numbered sections with anchor links ([](#section))
  • Compress ASCII art architecture block in favor of a placeholder SVG link under docs/ (matching the openfirma convention)
  • Convert long bullet lists into tables for deployment options, environment variables, API endpoints, compliance frameworks, and CIEM IAM nodes/edges
  • Group API reference by domain (Issues & risk / Compliance / CIEM) with separate query-parameter table

Notes

  • Logo/subtitle/diagram image refs (docs/khalifa-logo.png, docs/khalifa-subtitle.png, docs/khalifa-diagram.svg, docs/khalifa-architecture.svg) are placeholders. Drop assets into docs/ to fill them in.

Diff summary

README.md | 812 +++++++++++----------------------------------------
1 file changed, 200 insertions(+), 612 deletions(-)

…badges

Restructure README around numbered sections (What is / Deploy / Architecture
/ Repo structure) with anchor links, mirror the logo + tagline + badges
layout, and condense the deployment, API, compliance, and CIEM sections
into table form.

Add CI (GitHub Actions), License (BSD 3-Clause), and Built with
(TypeScript + Node.js) shields badges at the top.

Drop the ASCII architecture block in favor of a placeholder SVG link
under docs/ (matching the openfirma convention).
@therandomsecurityguy therandomsecurityguy merged commit c2bfa3d into main Jun 21, 2026
4 checks passed
@therandomsecurityguy therandomsecurityguy deleted the docs/readme-restyle branch June 21, 2026 01:08
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