From 594b423a8611eaf46cfe95227cccb1822eee96bf Mon Sep 17 00:00:00 2001 From: arturoBeccar Date: Wed, 25 Sep 2024 22:40:10 -0300 Subject: [PATCH] Add readmes --- proposal/getting-started/README.md | 21 ++++++++- proposal/getting-started/using-the-brige.md | 4 +- proposal/overview/README.md | 51 +++++++++++++++++++++ 3 files changed, 72 insertions(+), 4 deletions(-) create mode 100644 proposal/overview/README.md diff --git a/proposal/getting-started/README.md b/proposal/getting-started/README.md index 72c67c7..7094421 100644 --- a/proposal/getting-started/README.md +++ b/proposal/getting-started/README.md @@ -13,13 +13,30 @@ layout: visible: false --- -# :rocket: Getting Started with XLink +# 🚀 Getting Started with XLink XLink enables seamless transfers of digital assets across multiple blockchains, offering users an easy way to move tokens while maintaining control of their assets. Learn how to set up, connect your wallet, and start using XLink to bridge your assets across different blockchains. ## Choose where to start -
Prerequisitesprerequisites.mdcards/prerequisites.png
Using the Bridgeusing-the-bridge.mdcards/using-the-bridge.png
Guidesguides.mdcards/guides.png
+
+ +### Prerequisites +Learn about the requirements and supported wallets to begin using XLink. +- [Prerequisites](getting-started/prerequisites.md) +![Prerequisites](../.gitbook/assets/cards/prerequisites.png) + +### Using the Bridge +A step-by-step guide to using XLink to bridge your assets across chains. +- [Using the Bridge](getting-started/using-the-bridge.md) +![Using the Bridge](../.gitbook/assets/cards/using-the-bridge.png) + +### Guides +Detailed tutorials on connecting your wallet, managing assets, and using XLink features. +- [Guides](getting-started/guides/README.md) +![Guides](../.gitbook/assets/cards/guides.png) + +
## Support diff --git a/proposal/getting-started/using-the-brige.md b/proposal/getting-started/using-the-brige.md index 123a661..3a34110 100644 --- a/proposal/getting-started/using-the-brige.md +++ b/proposal/getting-started/using-the-brige.md @@ -7,7 +7,7 @@ Follow these steps to bridge your assets between chains using XLink! Before using the bridge you have to connect to XLink a wallet for the blockchain you will be bridging from and also one for the blockchain you will be briding to (e.g., **Stacks Chain**, **Bitcoin Chain** or **EVM Chain**). {% hint style="info" %} -See the [Prerequisites](prerequisites.md) section for the list of **Supported Wallets** and their installation guides. +See the [Prerequisites](./prerequisites) section for the list of **Supported Wallets** and their installation guides. {% endhint %} You can connect your wallet by clicking click on the **Wallet Manager** located in the top right corner of the XLink app. This is where you’ll manage all your wallet connections. @@ -17,7 +17,7 @@ You can connect your wallet by clicking click on the **Wallet Manager** located For some cases, you can use the same wallet for both blockchains, but you still need to connect it separately for both blockchains in order to specify the source and destination accounts. {% hint style="info" %} -For a detailed explanation on how to connect your wallet, check our guide: [**How to Connect your Wallet**](./guides/how-to-connect-your-wallet.md). +For a detailed explanation on how to connect your wallet, check our guide: [**How to Connect your Wallet**](./guides/how-to-connect-your-wallet). {% endhint %} Once you have connected both corresponding wallets, you will se them active on the **Wallet Manager**. diff --git a/proposal/overview/README.md b/proposal/overview/README.md new file mode 100644 index 0000000..dc144de --- /dev/null +++ b/proposal/overview/README.md @@ -0,0 +1,51 @@ +--- +description: Overview of XLink, the cross-chain bridge for seamless asset transfers. +layout: + title: + visible: true + description: + visible: true + tableOfContents: + visible: true + outline: + visible: true + pagination: + visible: false +--- + +# 🌐 Overview of XLink + +XLink is a cutting-edge cross-chain bridge that enables the seamless transfer of assets between different blockchains. Built with a focus on user experience and security, XLink allows users to move tokens across various supported blockchains while maintaining control over their assets at all times. + +Whether you're a developer, a crypto enthusiast, or just exploring the world of decentralized finance (DeFi), XLink simplifies the process of cross-chain transfers and enhances interoperability across networks. + +## Key Features + +- **Multi-Chain Support**: XLink supports a wide variety of blockchains, ensuring that users can bridge their assets between popular ecosystems like Stacks, Bitcoin, and more. +- **Seamless Asset Transfers**: Move your tokens securely and effortlessly across chains without losing control over your assets. +- **User-Friendly Interface**: Intuitive UI designed for users of all experience levels, from beginners to advanced DeFi users. +- **Secure Transactions**: Built with robust security features to ensure safe and reliable transactions across blockchains. + +## Learn More + +You can dive deeper into how XLink works and its capabilities by exploring the following sections: + +
+ +### Introduction +Get an in-depth look at XLink, including the vision behind its creation and how it facilitates cross-chain asset transfers. +- [Introduction](overview/introduction.md) + +### How XLink Bridge Works +Understand the technical architecture and how XLink ensures smooth, efficient asset transfers between blockchains. +- [How XLink Bridge Works?](overview/how-xlink-works.md) + +### Supported Blockchains and Tokens +Discover the blockchains and tokens supported by XLink for cross-chain transfers, including their specific functionalities. +- [Supported Blockchains and Tokens](overview/supported-blockchains-and-tokens.md) + +
+ +## Support + +For any questions or assistance, please join our community on [Discord](https://discord.com/invite/xlink) or follow us on [Telegram](https://x.com/XLinkbtc).