From 5d0ebdee66796378daad1db5f792dc9eb0a0a324 Mon Sep 17 00:00:00 2001
From: hu55a1n1 <sufialhussaini@gmail.com>
Date: Mon, 6 Nov 2023 02:22:21 -0800
Subject: [PATCH] Add root level README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9573bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# The Tendermint light client enclave
+
+This enclave runs tendermint/CometBFT light client verification on a given 'verification trace' using a user specified
+root-of-trust. It outputs the new root-of-trust to a sealed file so that it can be used for future instantiations.
+
+## Execution on an SGX machine
+
+This is tested on a local SGX machine, not Azure
+
+```bash
+docker build . --tag tmdocker build . --tag tm \
+docker run -it --device /dev/sgx_enclave \
+      -v /var/run/aesmd/aesm.socket:/var/run/aesmd/aesm.socket \
+      -v ./tests:/workdir/tests \
+      tm bash
+is-sgx-available
+gramine-sgx ./tm
+```