-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add badges to README.md #268
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @dusterbloom! Added some comments to fix stuff.
README.md
Outdated
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/informalsystems/cycles-quartz/pulls) | ||
[![GitHub Stars](https://img.shields.io/github/stars/informalsystems/cycles-quartz)](https://github.com/informalsystems/cycles-quartz/stargazers) | ||
[![Rust](https://img.shields.io/badge/Rust-passing-brightgreen)](https://github.com/informalsystems/cycles-quartz) | ||
[![msrv](https://img.shields.io/badge/msrv-1.72.1-blue)](https://github.com/informalsystems/cycles-quartz) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the msrv is incorrect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup ... changed
README.md
Outdated
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://github.com/informalsystems/cycles-quartz) | ||
[![Code Coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen)](https://github.com/informalsystems/cycles-quartz) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These should point to the actual workflow to show their status.
README.md
Outdated
@@ -1,3 +1,14 @@ | |||
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://github.com/informalsystems/cycles-quartz) | |||
[![Code Coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen)](https://github.com/informalsystems/cycles-quartz) | |||
[![docs](https://img.shields.io/badge/docs-passing-brightgreen)](https://github.com/informalsystems/cycles-quartz/docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can remove these -> cov, issues, PRs, stars.
And add e2e (workflow status) and rust: stable
.
This PR adds badges to the README.md as shown below
Quartz