docs(readme): restyle in openfirma format with CI/License/Built-with badges#5
Merged
Merged
Conversation
…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).
26de6e1 to
b24ca12
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
[](#section))docs/(matching the openfirma convention)Notes
docs/khalifa-logo.png,docs/khalifa-subtitle.png,docs/khalifa-diagram.svg,docs/khalifa-architecture.svg) are placeholders. Drop assets intodocs/to fill them in.Diff summary