From 34344d5684b0f50169bbbab6582aaab061aa0867 Mon Sep 17 00:00:00 2001
From: brunny <96834997+brunny-eth@users.noreply.github.com>
Date: Tue, 10 Sep 2024 13:32:42 -0400
Subject: [PATCH] Update README.md

Slight updates to the README to add a Contributors shield + some slight tidying up of languages / links
---
 README.md | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 2103831..9a73d60 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,21 @@
 <h1 align="center">
   ronkathon
 </h1>
-
-<p align="center">
-  ronkathon
-</p>
-
 <div align="center">
-  <a href="https://github.com/pluto/ronkathon/actions">
-    <img src="https://github.com/pluto/ronkathon/actions/workflows/test.yaml/badge.svg" />
-    <img src="https://github.com/pluto/ronkathon/actions/workflows/lint.yaml/badge.svg" />
+  <a href="https://github.com/pluto/ronkathon/graphs/contributors">
+    <img src="https://img.shields.io/github/contributors/pluto/ronkathon?style=flat-square&logo=github&logoColor=8b949e&labelColor=282f3b&color=32c955" alt="Contributors" />
+  </a>
+  <a href="https://github.com/pluto/ronkathon/actions/workflows/test.yaml">
+    <img src="https://img.shields.io/badge/tests-passing-32c955?style=flat-square&logo=github-actions&logoColor=8b949e&labelColor=282f3b" alt="Tests" />
+  </a>
+  <a href="https://github.com/pluto/ronkathon/actions/workflows/lint.yaml">
+    <img src="https://img.shields.io/badge/lint-passing-32c955?style=flat-square&logo=github-actions&logoColor=8b949e&labelColor=282f3b" alt="Lint" />
   </a>
-  </div>
+</div>
 
 ## Overview
 
-Ronkathon is a rust implementation of a collection of cryptographic primitives. It is inspired by the common python plonkathon repository, and plonk-by-hand. We use the same curve and field as plonk-by-hand (not secure), and are working towards building everything from scratch to understand everything from first principles.
+Ronkathon is a collection of cryptographic primitives implemented in Rust. It is inspired by the [python plonkathon repository](https://github.com/0xPARC/plonkathon) and [plonk-by-hand](https://research.metastate.dev/plonk-by-hand-part-1/). We use the same curve and field as plonk-by-hand (which is not secure) and the goal of this repository is to work towards building everything from scratch to understand everything from first principles.
 
 ## Multivariate polynomials and sum-check
 
@@ -26,7 +26,7 @@ This project implements the sum-check protocol for multivariate polynomials over
 - A `SumCheckVerifier` for verifying proofs
 - A `SumCheck` struct that encapsulates the entire protocol.
 
-Use
+You can use:
 
 `cargo run --example sumcheck_ex`
 
@@ -72,6 +72,7 @@ We have found the following resources helpful in understanding the foundational
 
 - [Plonk by Hand P1](https://research.metastate.dev/plonk-by-hand-part-1/)
 - [Plonk by Hand P2](https://research.metastate.dev/plonk-by-hand-part-2-the-proof/)
+- [Plonk by Hand P3](https://research.metastate.dev/plonk-by-hand-part-3-verification/)
 
 ### Code Refrences