Skip to content

docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev#9

Merged
itzzjustmateo merged 1 commit into
mainfrom
docs/readme-patch-1
Jul 16, 2026
Merged

docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev#9
itzzjustmateo merged 1 commit into
mainfrom
docs/readme-patch-1

Conversation

@itzzjustmateo

Copy link
Copy Markdown
Owner

Summary

Improved the project's README by updating the header image sizing and replacing the existing badges with a cleaner, more modern style. These changes improve the overall presentation and readability of the repository without affecting any functionality.

Related Issues

Closes #5

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would break existing functionality)
  • Documentation update
  • Refactoring (no functional changes)
  • CI/CD or build changes
  • Other (please describe):

Testing & Verification

  • I have run bash -n syntax checking on all modified scripts
  • I have run shellcheck on all modified scripts
  • I have verified the installer flow on a supported OS (describe below)

No script or installer changes were made. This PR only updates the project's README.

Checklist

  • My code follows the project's code style
  • I have updated the documentation where necessary
  • My changes do not introduce new warnings or errors

…shieldcn.dev

Updated images and badges in the README for better presentation.
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8bf8c273-3308-434f-9398-b7b1a8d2399e

📥 Commits

Reviewing files that changed from the base of the PR and between 0fbc08e and 300dff1.

📒 Files selected for processing (1)
  • README.md
📜 Recent review details
⚠️ CI failures not shown inline (8)

GitHub Actions: Markdown Lint / 0_Lint Markdown.txt: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run DavidAnson/markdownlint-cli2-action@v19
 with:
   globs: *.md
manual-guides/**/*.md
   separator:
 ##[endgroup]
 markdownlint-cli2 v0.17.2 (markdownlint v0.37.4)
 Finding: *.md manual-guides/**/*.md
 Linting: 10 file(s)
 Summary: 362 error(s)
 ##[error]CODE_OF_CONDUCT.md:116:1 MD034/no-bare-urls Bare URL used [Context: "https://www.contributor-covena..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md

GitHub Actions: Markdown Lint / Lint Markdown: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run DavidAnson/markdownlint-cli2-action@v19
 with:
   globs: *.md
manual-guides/**/*.md
   separator:
 ##[endgroup]
 markdownlint-cli2 v0.17.2 (markdownlint v0.37.4)
 Finding: *.md manual-guides/**/*.md
 Linting: 10 file(s)
 Summary: 362 error(s)
 ##[error]CODE_OF_CONDUCT.md:116:1 MD034/no-bare-urls Bare URL used [Context: "https://www.contributor-covena..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md

GitHub Actions: CI / 0_Executable Permissions.txt: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run failed=0
 �[36;1mfailed=0�[0m
 �[36;1mwhile IFS= read -r -d '' file; do�[0m
 �[36;1m  if ! test -x "$file"; then�[0m
 �[36;1m    echo "::error file=$file::$file is not executable"�[0m

GitHub Actions: CI / Bash Syntax Check: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run failed=0
 �[36;1mfailed=0�[0m
 �[36;1mwhile IFS= read -r -d '' file; do�[0m
 �[36;1m  if ! bash -n "$file"; then�[0m
 �[36;1m    echo "::error file=$file::Syntax error in $file"�[0m

GitHub Actions: CI / Executable Permissions: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run failed=0
 �[36;1mfailed=0�[0m
 �[36;1mwhile IFS= read -r -d '' file; do�[0m
 �[36;1m  if ! test -x "$file"; then�[0m
 �[36;1m    echo "::error file=$file::$file is not executable"�[0m

GitHub Actions: CI / 2_Bash Syntax Check.txt: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run failed=0
 �[36;1mfailed=0�[0m
 �[36;1mwhile IFS= read -r -d '' file; do�[0m
 �[36;1m  if ! bash -n "$file"; then�[0m
 �[36;1m    echo "::error file=$file::Syntax error in $file"�[0m

GitHub Actions: CI / 1_ShellCheck.txt: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run exit 1
 �[36;1mexit 1�[0m
 shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
 ##[endgroup]
 ##[error]Process completed with exit code 1.

GitHub Actions: CI / ShellCheck: docs(readme): update header image + refactor(shields): shields.io -> shieldcn.dev

Conclusion: failure

View job details

##[group]Run exit 1
 �[36;1mexit 1�[0m
 shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
 ##[endgroup]
 ##[error]Process completed with exit code 1.
🔇 Additional comments (2)
README.md (2)

2-12: LGTM!


81-85: LGTM!


New Features

  • Added LICENSE, CI, and Shell status badges using shieldcn.dev.

Bug Fixes

  • Replaced the outdated installer image with the Hydro Install Banner.

Refactors

  • Resized and reorganized README header content.
  • Replaced the installation screenshot with the shell install command.
Author Lines Added Lines Removed
Not specified 8 6

Walkthrough

The README replaces the old installer image, adds LICENSE, CI, and Shell badges, and moves the curl installation command directly into the Installation Options section.

Changes

README update

Layer / File(s) Summary
README presentation and installation guidance
README.md
The header uses the Hydro Install Banner and additional status badges; the installation menu screenshot is replaced with the curl install command.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: kazaminosuke

Poem

Old banners fade into the night,
New shields guard the README bright.
The curl command takes center stage,
No screenshot haunts the documentation page.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the README image and badge updates, including the shields.io to shieldcn.dev swap.
Description check ✅ Passed The description is directly about README presentation updates and stays on-topic for the patch.
Linked Issues check ✅ Passed The PR updates the README image as requested by issue #5, replacing the old installer image.
Out of Scope Changes check ✅ Passed The changes are limited to README presentation tweaks and do not introduce unrelated scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai
coderabbitai Bot requested a review from kazaminosuke July 16, 2026 00:12
@itzzjustmateo

Copy link
Copy Markdown
Owner Author

gonna merge it in a sec

@itzzjustmateo
itzzjustmateo merged commit e3be0ea into main Jul 16, 2026
5 of 7 checks passed
@itzzjustmateo
itzzjustmateo deleted the docs/readme-patch-1 branch July 16, 2026 03:12
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.

Wrong Image in README

1 participant