Skip to content

Restructure the README to the BruzIT outline - #13

Merged
bruzina merged 1 commit into
mainfrom
feature/readme-maturity-line
Oct 31, 2026
Merged

bruzina merged 1 commit into
mainfrom
feature/readme-maturity-line

Conversation

@bruzina

@bruzina bruzina commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor
  • Restructure README into the canonical BruzIT outline: flat H2s, required and optional sections.
  • Badge row: license, last commit, then one workflow badge per required workflow in pipeline order (MegaLinter, Semantic Release).
  • Template setup steps under Installation and Setup; Development, Testing, Integration and Deployment as own H2s.
  • Rename to License and Copyright; wording unchanged.

@bruzina bruzina self-assigned this Oct 29, 2026
@github-actions

github-actions Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

✅MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Max errors Warnings Elapsed time
✅ MARKDOWN markdownlint 1 0 0 0 0.4s
✅ MARKDOWN markdown-table-formatter 1 0 0 0 0.15s

See detailed reports in MegaLinter artifacts
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is provided by OX Security
Show us your support by starring ⭐ the repository

@bruzina
bruzina force-pushed the feature/readme-maturity-line branch from 8416087 to bc230cf Compare October 30, 2026 22:57
@bruzina bruzina changed the title Add maturity line to README docs: restructure readme to bruzit outline Oct 30, 2026
@bruzina
bruzina force-pushed the feature/readme-maturity-line branch 4 times, most recently from 71aeb1c to 81c0c58 Compare October 31, 2026 07:32
@bruzina bruzina changed the title docs: restructure readme to bruzit outline feat: restructure readme to bruzit outline Oct 31, 2026
@bruzina
bruzina force-pushed the feature/readme-maturity-line branch 7 times, most recently from 9242c8f to 1d072d6 Compare October 31, 2026 10:50
@bruzina
bruzina force-pushed the feature/readme-maturity-line branch from 1d072d6 to 2218fc7 Compare October 31, 2026 10:50
@bruzina bruzina changed the title feat: restructure readme to bruzit outline Restructure the README to the BruzIT outline Oct 31, 2026
@bruzina
bruzina merged commit 13daf7a into main Oct 31, 2026
2 checks passed
@bruzina
bruzina deleted the feature/readme-maturity-line branch October 31, 2026 13:23
@bruzit-github-contents

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant