docs: align README with ArchUnitTS - #49
Merged
Merged
Conversation
TristanKruse
approved these changes
Aug 18, 2026
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Pull request overview
This PR restructures README.md to match the sectioning and visual style used in ArchUnitTS, while keeping ArchUnitRuby’s Ruby-specific examples and guidance as the primary content.
Changes:
- Reworks the README header (badges, intro copy, and navigation) and adds a “5 min Quickstart”.
- Reorganizes existing content into clearer sections (Setup, Features, Use Cases, Debug/Config, Technical Deep Dive, Community).
- Adds CI integration snippet and community/maintainers sections plus a “back to top” link.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Architecture testing for Ruby. Part of **ArchUnitEverything**: one recognizable testing library | ||
| for each programming language. | ||
| <div align="center" name="top"> |
| _Inspired by the amazing ArchUnit library, but not affiliated with ArchUnit._ | ||
| [Setup](#-setup) · [Use Cases](#-use-cases) · [Features](#-features) · [Documentation](https://lukasniessen.github.io/ArchUnitRuby/) · [Sponsor](https://github.com/sponsors/LukasNiessen) · [Contributing](#-contributing) |
Comment on lines
+5
to
+6
| [](LICENSE) [](https://github.com/LukasNiessen/ArchUnitRuby/actions/workflows/ci.yml) [](https://github.com/LukasNiessen/ArchUnitRuby)<br> | ||
| [](https://clickgems.clickhouse.com/dashboard/archunit) [](https://www.ruby-lang.org/) |
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 freeto 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.
Summary
Validation