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.

Sign up for GitHub

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

Jump to bottom

Improved README with better formatting and added social links #3189

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improved README with better formatting and added social links #3189

wants to merge 4 commits into from
+84 −67

Conversation

NikolaiKryshnev
Copy link

Enhanced README Formatting & Structure

Key Updates:

  • Refactored structure – Improved organization for better readability and navigation.
  • Added GitHub badges – Displaying stars, forks, last commit, and license status.
  • Included important links – Website, documentation, and whitepaper now easily accessible.
  • Social media integration – Added Telegram, Discord, and Twitter badges for community engagement.
  • Improved Markdown formatting – Enhanced visuals for a cleaner and more structured layout.

This update improves the overall clarity, accessibility, and presentation of the README. 🚀

ma2bd
ma2bd reviewed Jan 31, 2025
View reviewed changes
@ma2bd
Copy link
Contributor

ma2bd commented Feb 3, 2025 •
edited
Loading

The changes are still breaking the test in CI somehow.

@thanhtinnn

This comment was marked as spam.

Sign in to view
@NikolaiKryshnev
Copy link
Author

@ma2bd Got it, thanks for the feedback! How can I help resolve this issue?

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

@ma2bd ma2bd ma2bd left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@NikolaiKryshnev @ma2bd @thanhtinnn