From 2298b73ab832f625cfd570fc79aa45fe5ba0c3fe Mon Sep 17 00:00:00 2001 From: c8e4 Date: Sun, 2 Jun 2024 19:33:08 +0200 Subject: [PATCH] fix typo, improve landing page --- README.md | 2 +- docs/01-Summary.md | 2 +- docs/06-KYA.md | 2 +- docs/README.md | 14 ++++---------- docs/_sidebar.md | 2 +- 5 files changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ee53019..bee2108 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ CrystalPool provides real-time balance and state updates. Each trading action ge To enhance the user experience, a built-in wallet is integrated into the trading client. The trading UI manages user balances based on the latest DEPOSIT, SWAP, BUY, and SELL activities. This built-in wallet ensures a seamless experience by signing transactions in the background. To maintain a trustless process, each transaction presents a simple summary **integrated in the UI** to the user, who can then choose to confirm or discard it. -**Know Your Assumtions (KYA)** +**Know Your Assumptions (KYA)** **Protocol:** All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions, with real-time balance calculations based on the latest known state. Security is ensured as CrystalPool cannot move user balances without the userPK. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period. diff --git a/docs/01-Summary.md b/docs/01-Summary.md index 03526ed..2ca569f 100644 --- a/docs/01-Summary.md +++ b/docs/01-Summary.md @@ -22,7 +22,7 @@ CrystalPool provides real-time balance and state updates. Each trading action ge To enhance the user experience, a built-in wallet is integrated into the trading client. The trading UI manages user balances based on the latest DEPOSIT, SWAP, BUY, and SELL activities. This built-in wallet ensures a seamless experience by signing transactions in the background. To maintain a trustless process, each transaction presents a simple summary **integrated in the UI** to the user, who can then choose to confirm or discard it. -**Know Your Assumtions (KYA)** +**Know Your Assumptions (KYA)** **Protocol:** All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions. User funds are protected by userPK at the level of smart-contracts. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period. diff --git a/docs/06-KYA.md b/docs/06-KYA.md index a8bbf6c..c41cf90 100644 --- a/docs/06-KYA.md +++ b/docs/06-KYA.md @@ -1,4 +1,4 @@ -**Know Your Assumtions (KYA)** +**Know Your Assumptions (KYA)** **Protocol:** All transactions are settled on L1 and incur a transaction fee. CrystalPool maintains a public set of unsubmitted transactions. User funds are protected by userPK at the level of smart-contracts. In case of service shutdown, users can withdraw their deposits/orders after the unlockHeight period. diff --git a/docs/README.md b/docs/README.md index 971ad0e..17c6970 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,8 @@ -# CrystalPool: Instant trades on L1 +# CrystalPool: Instant Trades on L1 -Welcome to the CrystalPool documentation. This book provides an in-depth look into the development of a **self-custodial** limit order exchange on Ergo L1 with **instant** order execution and clear KYA. - -## Screenshot +![CrystalPool UI](./ui.png?raw=true "CrystalPool UI") -![CrystalPool UI](./ui.png?raw=true "Crystal Pool UI") +Welcome to the CrystalPool documentation. This book provides an in-depth look into the development of a **self-custodial** limit order exchange on Ergo L1 with **instant** order execution and clear KYA. ## Table of Contents @@ -12,9 +10,5 @@ Welcome to the CrystalPool documentation. This book provides an in-depth look in - [Project Goals](02-Project-Goals.md) - [Key Components](03-Key-Components.md) - [Built-in Wallet](04-Built-in-Wallet.md) -- [Know Your Assumtions (KYA)](05-KYA.md) +- [Know Your Assumptions (KYA)](05-KYA.md) - [Smart Contracts](06-Smart-Contracts.md) - -## Screenshot - -![CrystalPool UI](./ui.png?raw=true "Crystal Pool UI") \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md index cc2c240..7978502 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -4,4 +4,4 @@ - [Built-in Wallet](03-Built-in-Wallet.md) - [Token Swap Example](04-Token-Swap-Example.md) - [Smart Contracts](05-Smart-Contracts.md) -- [Know Your Assumtions (KYA)](06-KYA.md) +- [Know Your Assumptions (KYA)](06-KYA.md)