Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Readme #2075

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ _The project is still heavily under construction, see the [disclaimer below](#st
[![CodeCov](https://codecov.io/gh/berachain/beacon-kit/graph/badge.svg?token=0l5iJ3ZbzV)](https://codecov.io/gh/berachain/beacon-kit)
[![Telegram Chat](https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fbeacon_kit)](https://t.me/beacon_kit)
[![X Follow](https://img.shields.io/twitter/follow/berachain)](https://x.com/berachain)
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://discord.com/invite/berachain)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

LGTM! Consider adding alt text for accessibility.

The addition of the Discord badge is well-implemented:

  • It uses a reputable badge service (img.shields.io).
  • The link to the Discord server is correct.
  • Its placement is appropriate, alongside other community-related badges.
  • The style is consistent with other badges.

For improved accessibility, consider adding alt text to the badge. Here's a suggested modification:

[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://discord.com/invite/berachain "Join our Discord server")

This change adds a descriptive title attribute to the link, which can improve the experience for users relying on screen readers.


</div>

Expand Down
Loading