From 21b64762453180c43deb2d804cdee61d0b3b76b9 Mon Sep 17 00:00:00 2001
From: Adriagc8 <62480517+Adriagc8@users.noreply.github.com>
Date: Thu, 26 Oct 2023 09:59:17 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5d90f7b..413b3f1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
-# DC-EBC-Hackathon
-DC-EBC-Hackathon
+# decertifierAPI
+Welcome to the first version of DeCertifier!
+
+DeCertifier is a tool for certifying groups of documents of the same event, this allows to verify that each document takes part on this event and any of them had been modified.
How it works: it hashes every document, then creates a merkel tree and saves the merkel root in the Blockchain. 
+How to verify: Given a document and an eventId, you can verify that this document takes part on the event. As the merkel root is saved on the blockchain, you can check that the merkel tree is valid, then using the merkel tree and the hash of the document you can calculate the merkel proofs
+
+## API requests:
+### Certify
+POST https://certifier.universalplastic.io/notarize
+body: {
+    "eventId": String,
+    "documents": [String]
+}
+### Certify
+POST https://certifier.universalplastic.io/validate
+body: {
+    "eventId": String,
+    "document": String
+}
+
+## TEST
+You can test it here: https://decertifier.retool.com/embedded/public/d92a6fa3-d5a6-4615-bb78-0016c45ee1e0
+
+## Designs for the client:
+![image](https://github.com/UniversalPlastic-io/decertifierAPI/assets/62480517/07d01108-a5a1-40b2-9ba5-98837e45b9a4)