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

Add badges to README.md #268

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

Conversation

dusterbloom
Copy link
Contributor

This PR adds badges to the README.md as shown below

Build Status Code CoveragedocsGitHub IssuesPRs WelcomeGitHub StarsRustmsrvcrates.ioLicense

Quartz

@dusterbloom dusterbloom added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 21, 2024
@dusterbloom dusterbloom self-assigned this Oct 21, 2024
@dusterbloom dusterbloom linked an issue Oct 21, 2024 that may be closed by this pull request
@dusterbloom dusterbloom requested a review from hu55a1n1 October 21, 2024 09:31
@dusterbloom dusterbloom modified the milestone: Quartz v0.1 Oct 21, 2024
Copy link
Member

@hu55a1n1 hu55a1n1 left a 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)
Copy link
Member

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.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

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
Comment on lines 1 to 2
[![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)
Copy link
Member

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)
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add badges to the README
3 participants