From 65ff538168c2d5eec2142ac7e52ab3c34ef0a2ac Mon Sep 17 00:00:00 2001
From: Dima S <dima@sukhikh.xyz>
Date: Fri, 28 Jun 2024 00:46:58 +0200
Subject: [PATCH] Update readme add env.example file

---
 .env.example |  4 ++++
 README.md    | 43 ++++++++++++++++++++++++++++++++-----------
 2 files changed, 36 insertions(+), 11 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..564eed4
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,4 @@
+DENO_KV_ACCESS_TOKEN=DENO_KV_ACCESS_TOKEN
+BLOCKFROST=BLOCKFROST
+POLICY_ID=POLICY_ID
+ASSET=ASSET
diff --git a/README.md b/README.md
index 6882c1d..ae6be1b 100644
--- a/README.md
+++ b/README.md
@@ -2,29 +2,50 @@
 
 > Emurgo Academy Final Project
 
-## Mint Platform NFT
+## Project Overview
 
-1. Go to https://estate-club.deno.dev/admin
+The idea of the project is to fractionalize real estate property. The minimum amount is a square decimeter. The manager creates a bid with the address, size, and price of the property. The bid is a Cardano smart contract, and every contract is unique because the validator uses UTXO-ref as an input. While creating the Plutus Script, the manager mints tokens in an amount equal to the size of the property and locks the tokens on the script address.
 
-2. Connect the Nami Wallet by clicking the "Setup Lucid" button
+Investors then start to lock ADA on the script. If the amount of ADA is equal to or more than the price of the property, the bid is funded, and the manager can distribute tokens between investors and unlock the ADA from the script. If the bid is not funded, investors can request a refund. Every investor can always refund (unlock) their own ADA.
 
-3. Click the Mint button
+## Developer Guide
 
-[platform_nft.webm](https://github.com/coddeys/fractional-nft-real-estate/assets/4198294/b360f8d5-7c6c-4614-a221-fa29d70addb8)
+### Development Smart Contracts
 
-## Development
+To build the compiled version code, use the following command:
 
-Then start the project:
+```
+aiken build --trace-level verbose
+
+```
+
+### Development Frontend
+
+Start the frontend project:
 
 ```
 deno task start
 ```
 
-This will watch the project directory and restart as necessary.
+This command will monitor the project directory and restart as needed.
 
-## Deployment
+### Deployment
 
-The project will be automatically released to the Deno Deploy platform using a
-GitHub workflow.
+The project will be automatically deployed to the Deno Deploy platform using a GitHub workflow.
 
 https://estate-club.deno.dev/
+
+
+# User Guide
+
+## Mint Platform NFT
+
+1. Visit https://estate-club.deno.dev/admin
+
+2. Connect the Nami Wallet by clicking the "Setup Lucid" button
+
+3. Click the Mint button
+
+Visual guide:
+
+[platform_nft.webm](https://github.com/coddeys/fractional-nft-real-estate/assets/4198294/b360f8d5-7c6c-4614-a221-fa29d70addb8)