From 08231a4d226e4a80aab3e93a58a5d2f0959a6913 Mon Sep 17 00:00:00 2001
From: Danny Grove <danny@dannygrove.com>
Date: Thu, 29 Aug 2024 13:27:55 -0700
Subject: [PATCH] Fix formatting issues and use a table to make layout cleaner

---
 README.md | 100 +++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 73 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index db97889..1c69c18 100644
--- a/README.md
+++ b/README.md
@@ -24,37 +24,83 @@ VCS Support
 * Mercurial -- `hg+`
 * Subversion -- `svn+`
 
-version: The version of the schema
-reviewer: RFC5322 name-addr format (eg. John Doe <johndoe@example.com>)
-treehash: sha256sum of treehashes
-paths: a list of filepaths reviewed or reproduced, can include globs
-artifcts: a list of built artificats with hashes if relevant
-vcs-ref: VCS ref
-type: The type of review. Allowed values are: function, security, readability, reproducibility
-system:
-  platform:
-  cpu:
-  cores:
-comments: freeform text
 
 ## Format
 
-``
+| Field Name | Decription | Required |
+| :--- | :--- | :---: |
+| version | The version of the schema | yes |
+| reviewer | RFC5322 name-addr format (eg. John Doe <johndoe@example.com>) | yes |
+| treehash | sha256sum of treehashes | yes |
+| paths | a list of filepaths reviewed or reproduced, can include globs | yes |
+| artifcts | a list of built artificats with hashes if relevant | no |
+| vcs-ref | VCS ref | yes |
+| type | The type of review. Allowed values are: function, security, readability, reproducibility | yes |
+| confidence | How confident are you in the type of review you did: `low,medium,high` | yes |
+| system.platform | The platform used to build `amd64,arm64,etc` | yes |
+| system.cpu | Information about the CPU used | no |
+| system.cores | Number of cores in CPU | no |
+| system.location | location of machine(mostly for reproducibility, if in 'the cloud' include the region e.g AWS:us-east-1, could also be ISO 3166-2) | no |
+| comments | freeform text | no |
+
+### Security Review Example
+
+```
 version: 0.1
-reviewer:
-treehash:
+reviewer: Danny Grove <danny@dannygrove.com>
+treehash: 9cc0641a294d3ee359ae474aef1a9a6a6657aeb2 
 paths:
-- list of file paths reviewed or reproduced
-- supports glob format
-artifacts:
-- list of built artificats with hashes if relevant
-vcs-ref:
-type: "function|security|readability|reproduction",
-confidence: "low|medium|high"
+- ./* 
+vcs-ref: git+https://github.com/drGrove/mtls-cli
+type: "security",
+confidence: "high"
 system:
-  platform:
-  cpu:
-  cores:
-  location: "home|aws|gcp|etc"
+  platform: amd64
+  location: "ISO3166-2:US-CA"
 comments: |
-  This is a freeform area
+  Very Secure, much wow
+```
+
+### Reproducible Build Example(s)
+
+```
+version: 0.1
+reviewer: Github Action <github-actions[bot]@users.noreply.github.com> 
+treehash: a5fc98c3950d7bb6bf083d5e7c08a91ffef990af
+paths:
+- ./* 
+vcs-ref: git+https://git.distrust.co/public/enclaveos
+type: "reproducibility",
+confidence: "high"
+system:
+  platform: amd64
+  location: "GHA" # Github Actions, if you're using self-hosted runners use the runners code. e.g. AWS:us-west-2
+```
+
+```
+version: 0.1
+reviewer: Danny Grove
+treehash: a5fc98c3950d7bb6bf083d5e7c08a91ffef990af
+paths:
+- ./* 
+vcs-ref: git+https://git.distrust.co/public/enclaveos
+type: "reproducibility",
+confidence: "high"
+system:
+  platform: amd64
+  location: "AWS:us-east-1"
+```
+
+```
+version: 0.1
+reviewer: Danny Grove
+treehash: a5fc98c3950d7bb6bf083d5e7c08a91ffef990af
+paths:
+- ./* 
+vcs-ref: git+https://git.distrust.co/public/enclaveos
+type: "reproducibility",
+confidence: "high"
+system:
+  platform: amd64
+  location: "AWS:us-east-1"
+```