soramitsu · bgodlin · Feb 3, 2023 · Feb 6, 2023 · Feb 6, 2023 · Feb 7, 2023
diff --git a/README.md b/README.md
@@ -1,4 +1,17 @@
-# adar
+# ADAR
+
+<div align="center">
+  <div align=center><img src="https://adar.com/i/adar-logo-new.svg" width=" 500 "></div>
+  <h3 align="center"> Advanced Digital Asset Routing</h3>
+  <br />
+ <a href="https://www.adar.com/">Website</a>｜<a href="https://sora.org">SORA blockchain</a>
+</div>
+
+# Docs
+
+[Get started (testnet)](./docs/GUIDES.md)
+
+# Development
 
 ## Project deploy info
 There is `public/env.json` file which contains `BASE_API_URL` and `DEFAULT_NETWORKS` variables.

diff --git a/docs/GUIDES.md b/docs/GUIDES.md
@@ -0,0 +1,92 @@
+Welcome to ADAR (Advanced Digital Asset Routing) - a unique solution for businesses to seamlessly transmit digital assets to payees around the world in multiple currencies, at a fraction of today’s prevailing transaction costs, and without excessive paperwork and settlement times. In this guide, we will provide an overview of the main ADAR user cases, describing each stage in detail.
+
+> 📝 In this guide, we will use a test environment - all links inserted further will only point to test components.
+
+**Step 1.** Proceed to the [ADAR Testnet](https://testnet.adar.com)
+
+![](./assets/main.png)
+
+**Step 2.** Connect your wallet
+
+[Wallet Connection Walkthrough](./assets/connect_wallet.mov)
+
+![](./assets/connect_wallet.png)
+
+ADAR  is based on the SORA blockchain, proceed to the [SORA website](https://sora.org) to read more. This means that you need to use wallets compatible with the SORA network to explore ADAR.
+
+The demo example will use the `polkadot.js` extension. To install the extension and read the documentation, please visit the [Polkadot.JS website](https://polkadot.js.org/extension/).
+
+Once the wallet is successfully connected, you will see a corresponding address on the top right corner.
+
+![](./assets/main_wallet_connected.png)
+
+**Step 3.** Top up your SORA address using the faucet
+
+[Faucet Walkthrough](./assets/faucet.mov)
+
+> 📝 This stage is relevant only for the test environment
+
+*Step 3.1.* Proceed to https://testfaucet.polkaswap.io/
+
+![](./assets/faucet.png)
+
+*Step 3.2.* Enter your wallet address and the amount to be topped up
+
+*Step 3.3.* Execute the faucet
+
+*Step 3.4.* Check your wallet balance on the [ADAR platform](https://testnet.adar.com/#/wallet) to verify if the faucet transaction was successful
+
+![](./assets/balance.png)
+
+*Step 3.5.* 🟢 Once you have received the funds, you may continue exploring ADAR functions
+
+**Step 4.** Route the assets
+
+[Asset Routing Walkthrough](./assets/main_flow.mp4)
+
+*Step 3.1.* Proceed to the [asset routing page](https://testnet.adar.com/#/route-assets)
+
+![](./assets/main_wallet_connected.png)
+
+*Step 3.2.* Upload a routing configuration (`.csv` file). On this page you will be able to find the template. Once you upload the file, ADAR will validate it. We have provided an [example template](./assets/template.csv). You are welcome to modify this template or create your own. However, please note that our application does not support multiple transactions to the same wallet in the template. Please ensure that you do not use one wallet twice, as we expect salaries to be distributed as usual.
+
+![](./assets/csv_validation.png)
+
+Step 3.2.1. If there are configuration issues, ADAR will concisely indicate them, so that you can edit the `csv` file and subsequently re-upload it
+
+![](./assets/issue_found.png)
+
+![](./assets/issue_highlighted.png)
+
+![](./assets/issue_resolved.png)
+
+*Step 3.3.* Select an input asset
+
+![](./assets/input_asset_selection.png)
+
+As part of the current version, ADAR can use only one source asset and any number of target assets for a batch transfer of funds. This means that if the user specified `PSWAP` as the receiving asset, and `XOR` was selected as the source asset, then `XOR` will first be converted to `PSWAP` and then sent.
+![](./assets/swap.png)
+
+*Step 3.4.* Confirm the transaction
+
+![](./assets/confirmation.png)
+
+*Step 3.5.* Sign the transactions
+
+![](./assets/sign.png)
+
+Within the current implementation, several transactions will need to be signed in the case where asset coversion is needed before transfering the assets. In any case, it will always be done within the web extension (ie Polkadot.js).
+
+*Step 3.6.* Wait until the transaction is included in the blockchain. Once the transactions are executed successfully, ADAR will display the corresponding statuses on a web page
+
+![](./assets/routing_result.png)
+
+![](./assets/routing_result_end.png)
+
+Step 3.6.1. If there were problems with the batch transfers, you will see the corresponding errors, and you can immediately retry the transfer within the UI
+
+*Step 3.7.* Download an automatically generated PDF file
+
+![](./assets/pdf.png)
+
+🎉 Congratulations! You have completed a batch asset transfer using ADAR.
diff --git a/docs/assets/balance.png b/docs/assets/balance.png
diff --git a/docs/assets/confirmation.png b/docs/assets/confirmation.png
diff --git a/docs/assets/confirmation_not_enough_money.png b/docs/assets/confirmation_not_enough_money.png
diff --git a/docs/assets/connect_wallet.mov b/docs/assets/connect_wallet.mov
diff --git a/docs/assets/connect_wallet.png b/docs/assets/connect_wallet.png
diff --git a/docs/assets/csv_validation.png b/docs/assets/csv_validation.png
diff --git a/docs/assets/faucet.mov b/docs/assets/faucet.mov
diff --git a/docs/assets/faucet.png b/docs/assets/faucet.png
diff --git a/docs/assets/input_asset_selection.png b/docs/assets/input_asset_selection.png
diff --git a/docs/assets/issue_found.png b/docs/assets/issue_found.png
diff --git a/docs/assets/issue_highlighted.png b/docs/assets/issue_highlighted.png
diff --git a/docs/assets/issue_resolved.png b/docs/assets/issue_resolved.png
diff --git a/docs/assets/main.png b/docs/assets/main.png
diff --git a/docs/assets/main_flow.mp4 b/docs/assets/main_flow.mp4
diff --git a/docs/assets/main_wallet_connected.png b/docs/assets/main_wallet_connected.png
diff --git a/docs/assets/pdf.png b/docs/assets/pdf.png
diff --git a/docs/assets/routing_info.png b/docs/assets/routing_info.png
diff --git a/docs/assets/routing_result.png b/docs/assets/routing_result.png
diff --git a/docs/assets/routing_result_end.png b/docs/assets/routing_result_end.png
diff --git a/docs/assets/sign.png b/docs/assets/sign.png
diff --git a/docs/assets/swap.png b/docs/assets/swap.png
diff --git a/docs/assets/template.csv b/docs/assets/template.csv
@@ -0,0 +1,5 @@
+Alan MacLeod,5CDfwaL7sUuZxH2ukNz89PXecgwzBSdgahXn9GgfGQR35ien,0.2,VAL
+Adam Mills,5FhhdKqMUFC12nHCGEHPXQhCbbb3GDbENRht73nBDrp9qQrm,0.2,TBCD
+Alanna Porter,5CFQz9DaiRYvq1s4twn9RnLKCaMimNcdP7AASKcSi1sb1Hqe,0.2,TBCD
+Alexander Thomson,5G6FLYWiwu44WN75Xxa3hq8APURtcCgLyP9WJoaDyNTgLmZr,0.2,XOR
+Alexandra Gibson,5CDfwaL7sUuZxH2ukNz89PXecgwzBSdgahXn9GgfGQR35ien,0.2,DEO