From 859c8ccab3f9f5a7f53b3279276f0e99079b5519 Mon Sep 17 00:00:00 2001
From: mik-tf <logismos@protonmail.ch>
Date: Wed, 11 Dec 2024 16:11:37 -0500
Subject: [PATCH] update readme

---
 README.md | 33 +++++++++++++++++++++++++++------
 yarn.lock |  5 -----
 2 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index f8b0d33..955efda 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,33 @@
-# testsite 
+<h1>ThreeFold V4 Docs</h1>
 
-just edit the docs in directory 'docs'
+<h2>Table of Contents</h2>
 
-the site will be autobuild on [https://info.ourworld.tf/hero](https://info.ourworld.tf/hero)
+- [Introduction](#introduction)
+- [Steps](#steps)
+- [URL](#url)
 
+---
 
-## to edit in stackblitz
+## Introduction
 
-> make sure to have an account there, login with github
+This repository contains the code to deploy the ThreeFold V4 Docs.
 
-https://stackblitz.com/~/github.com/Incubaid/docs_eden
\ No newline at end of file
+## Steps
+
+- Install
+    ```
+    bash install.sh
+    ```
+- Run locally
+    ```
+    bash develop.sh
+    ```
+- Push change online
+    ```
+    bash build.sh
+    ```
+
+## URL
+
+- The website in staging mode is at `threefold.info/docs4`
+- The website in production mode is at `docs.threefold.io`
\ No newline at end of file
diff --git a/yarn.lock b/yarn.lock
index 779b0fc..c101408 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -5075,11 +5075,6 @@ fs.realpath@^1.0.0:
   resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
-fsevents@~2.3.2:
-  version "2.3.3"
-  resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz"
-  integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
-
 function-bind@^1.1.2:
   version "1.1.2"
   resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz"