From 63e5d1ec8857511ab635c7f7f8b1bfa8a7b4537e Mon Sep 17 00:00:00 2001 From: Ajeeta Asthana Date: Wed, 9 Apr 2025 00:51:15 -0400 Subject: [PATCH 1/2] docs: add developer-friendly badges to README This PR adds developer friendly badges to the repository. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6527fd9cf..836236da8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ +[![Go Reference](https://pkg.go.dev/badge/github.com/hashicorp/raft.svg)](https://pkg.go.dev/github.com/hashicorp/raft) +[![Go Report Card](https://goreportcard.com/badge/github.com/hashicorp/raft)](https://goreportcard.com/report/github.com/hashicorp/raft) +[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) +[![Build Status](https://github.com/hashicorp/raft/actions/workflows/ci.yml/badge.svg)](https://github.com/hashicorp/raft/actions) +[![Release](https://img.shields.io/github/v/release/hashicorp/raft)](https://github.com/hashicorp/raft/releases) +[![Issues](https://img.shields.io/github/issues/hashicorp/raft)](https://github.com/hashicorp/raft/issues) +[![Pull Requests](https://img.shields.io/github/issues-pr/hashicorp/raft)](https://github.com/hashicorp/raft/pulls) + # Raft library Raft is a protocol with which a cluster of nodes can maintain a replicated state machine. @@ -198,4 +206,4 @@ This approach introduces a problem when removing a member from a two-member clus ## Go docs -More detailed development documentation can be found in go docs: https://pkg.go.dev/go.etcd.io/raft/v3. \ No newline at end of file +More detailed development documentation can be found in go docs: https://pkg.go.dev/go.etcd.io/raft/v3. From 0cefd13d95dddd0ee168f42bfe6a517d09fefe30 Mon Sep 17 00:00:00 2001 From: Ajeeta Asthana Date: Wed, 9 Apr 2025 01:08:54 -0400 Subject: [PATCH 2/2] docs: add badges to README for better developer visibility Add developer-friendly badges to README.md for improved project visibility and quick access to key project metadata: - Go Reference - Go Report Card - GitHub Actions CI status - License - Latest Release - Open Issues & PRs This helps contributors and users quickly assess project health and navigate resources. --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 836236da8..345a06aff 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -[![Go Reference](https://pkg.go.dev/badge/github.com/hashicorp/raft.svg)](https://pkg.go.dev/github.com/hashicorp/raft) -[![Go Report Card](https://goreportcard.com/badge/github.com/hashicorp/raft)](https://goreportcard.com/report/github.com/hashicorp/raft) -[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0) -[![Build Status](https://github.com/hashicorp/raft/actions/workflows/ci.yml/badge.svg)](https://github.com/hashicorp/raft/actions) -[![Release](https://img.shields.io/github/v/release/hashicorp/raft)](https://github.com/hashicorp/raft/releases) -[![Issues](https://img.shields.io/github/issues/hashicorp/raft)](https://github.com/hashicorp/raft/issues) -[![Pull Requests](https://img.shields.io/github/issues-pr/hashicorp/raft)](https://github.com/hashicorp/raft/pulls) +[![Go Reference](https://pkg.go.dev/badge/go.etcd.io/raft)](https://pkg.go.dev/go.etcd.io/raft) +[![Go Report Card](https://goreportcard.com/badge/github.com/etcd-io/raft)](https://goreportcard.com/report/github.com/etcd-io/raft) +[![Build Status](https://github.com/etcd-io/raft/actions/workflows/test.yml/badge.svg)](https://github.com/etcd-io/raft/actions) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Release](https://img.shields.io/github/v/release/etcd-io/raft)](https://github.com/etcd-io/raft/releases) +[![Issues](https://img.shields.io/github/issues/etcd-io/raft)](https://github.com/etcd-io/raft/issues) +[![Pull Requests](https://img.shields.io/github/issues-pr/etcd-io/raft)](https://github.com/etcd-io/raft/pulls) + # Raft library