From eb812dae37c1ef6227b85ac44db18eb9643b732d Mon Sep 17 00:00:00 2001
From: exdx <dan.sover@avalabs.org>
Date: Tue, 5 Sep 2023 12:51:17 -0400
Subject: [PATCH] docs: Add conformance README (#15)

Signed-off-by: Dan Sover <dan.sover@avalabs.org>
---
 .gitignore                        |  1 +
 avalanchego-conformance/README.md | 47 +++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)

diff --git a/.gitignore b/.gitignore
index 668f240..dd86146 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,3 +17,4 @@ Cargo.lock
 
 .DS_Store
 .vscode
+.idea
diff --git a/avalanchego-conformance/README.md b/avalanchego-conformance/README.md
index ae30cfa..c939ffd 100644
--- a/avalanchego-conformance/README.md
+++ b/avalanchego-conformance/README.md
@@ -1,3 +1,12 @@
+# avalanche-conformance 
+
+avalanche-conformance is a tool used to ensure code is compatible with avalanchego. The tool performs byte level 
+checking for the avalanchego codec as well as key generations. The code is run against a live avalanchego node. 
+
+avalanche-conformance is a gRPC server that accepts client connections on a configurable port. A client library is also
+provided. 
+
+## Usage 
 
 ```bash
 go install -v ./cmd/avalanchego-conformance
@@ -5,3 +14,41 @@ avalanchego-conformance server \
 --port 9090 \
 --grpc-gateway-port 9091
 ```
+
+The following gRPC messages are implemented by the gRPC server:
+
+Keys 
+* CertificateToNodeId
+* Secp256K1RecoverHashPublicKey
+* Secp256K1Info
+* BlsSignature
+
+Node Messages 
+* AcceptedFrontier
+* AcceptedStateSummary
+* Accepted
+* Ancestors
+* AppGossip
+* AppRequest
+* AppResponse
+* Chits
+* GetAcceptedFrontier
+* GetAcceptedStateSummary
+* GetAccepted
+* GetAncestors
+* GetStateSummaryFrontier
+* Get
+* Peerlist
+* Ping
+* Pong
+* PullQuery
+* PushQuery
+* Put
+* StateSummaryFrontier
+* Version
+
+Vertex Messages
+* BuildVertex
+
+Server Messages
+* PingService
\ No newline at end of file