Update the unvesting-app readme

threefoldfoundation · Mar 28, 2023 · eb1770a · eb1770a
1 parent 7a8b827
commit eb1770a
Showing 1 changed file with 9 additions and 8 deletions.
diff --git a/unvesting-app/README.md b/unvesting-app/README.md
@@ -1,14 +1,15 @@
-# TF-Vesting
+# UnVesting webapp
 
-## Installtion
+A small website that operates completely from the browser.
 
-```sh
-    git clone https://github.com/threefoldfoundation/tft-stellar.git
-    cd tft-stellar/tf-vesting
-```
+It lets someone search for a vesting account using a Stellar address and if found, it fetches the unvesting transaction from the vesting_service.
+
+The user can then sign it with its private key and submit it to the Stellar network.
 
-### How to run
+The private key is only used inside the webpage to sign the transaction and is never stored or sent anywhere else.
+
+## How to run
 
 ```sh
     yarn & yarn dev 
-```
+```