Skip to content

chore: add README badges#111

Merged
sdbondi merged 1 commit intomainfrom
fix-readme-badges
Apr 6, 2026
Merged

chore: add README badges#111
sdbondi merged 1 commit intomainfrom
fix-readme-badges

Conversation

@sdbondi
Copy link
Copy Markdown
Member

@sdbondi sdbondi commented Apr 6, 2026

No description provided.

@sdbondi sdbondi changed the title chore: add badges chore: add README badges Apr 6, 2026
@sdbondi sdbondi merged commit 04676c3 into main Apr 6, 2026
4 checks passed
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md file to include new badges for Crates.io and docs.rs, and updates the CI status badge. I have identified a potential issue regarding the consistency of the crate name used in the badges versus the installation instructions, and I have suggested restoring the test coverage badge to maintain visibility into project health.

![CI Build Status](https://img.shields.io/github/actions/workflow/status/tari-project/tari-cli/ci.yml)
[![GitHub Release](https://img.shields.io/github/v/release/tari-project/tari-cli)](https://github.com/tari-project/tari-cli/releases)
[![CI Build Status](https://img.shields.io/github/actions/workflow/status/tari-project/tari-cli/pr-check.yml)](https://github.com/tari-project/tari-cli/actions/workflows/pr-check.yml)
[![Crates.io](https://img.shields.io/crates/v/tari-ootle-cli)](https://crates.io/crates/tari-ootle-cli)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The crate name tari-ootle-cli used in this badge is inconsistent with the installation command cargo install tari-cli mentioned in the Quick Start section (line 31). These should be made consistent to avoid user confusion during installation.

Comment on lines +131 to +133
- **Build Status**: [![CI](https://img.shields.io/github/actions/workflow/status/tari-project/tari-cli/pr-check.yml)](https://github.com/tari-project/tari-cli/actions/workflows/pr-check.yml)
- **Latest Release**: [![Release](https://img.shields.io/github/v/release/tari-project/tari-cli)](https://github.com/tari-project/tari-cli/releases)
- **Crates.io**: [![Crates.io](https://img.shields.io/crates/v/tari-ootle-cli)](https://crates.io/crates/tari-ootle-cli)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The Test Coverage badge was removed in this update. If the project still utilizes Codecov for tracking test coverage, it is recommended to retain this badge in the Project Status section for better visibility of the codebase's health.

Suggested change
- **Build Status**: [![CI](https://img.shields.io/github/actions/workflow/status/tari-project/tari-cli/pr-check.yml)](https://github.com/tari-project/tari-cli/actions/workflows/pr-check.yml)
- **Latest Release**: [![Release](https://img.shields.io/github/v/release/tari-project/tari-cli)](https://github.com/tari-project/tari-cli/releases)
- **Crates.io**: [![Crates.io](https://img.shields.io/crates/v/tari-ootle-cli)](https://crates.io/crates/tari-ootle-cli)
- **Build Status**: [![CI](https://img.shields.io/github/actions/workflow/status/tari-project/tari-cli/pr-check.yml)](https://github.com/tari-project/tari-cli/actions/workflows/pr-check.yml)\n- **Test Coverage**: [![Coverage](https://img.shields.io/codecov/c/github/tari-project/tari-cli)](https://codecov.io/gh/tari-project/tari-cli)\n- **Latest Release**: [![Release](https://img.shields.io/github/v/release/tari-project/tari-cli)](https://github.com/tari-project/tari-cli/releases)\n- **Crates.io**: [![Crates.io](https://img.shields.io/crates/v/tari-ootle-cli)](https://crates.io/crates/tari-ootle-cli)

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.

1 participant