feat: README.md

README.md

@@ -0,0 +1,56 @@
+# Example Repository for [Alex SDK](https://github.com/alexgo-io/alex-sdk)
+
+Welcome to the `alex-sdk-example` repository! This example project demonstrates how to use the Alex SDK to integrate powerful features and capabilities into your applications. Follow the instructions below to get started and run the demo locally.
+
+## Prerequisites
+
+Before you begin, make sure you have the following installed on your system:
+
+- Node.js
+- Yarn
+- Git
+
+## Getting Started
+
+1. **Clone the repository**
+   Clone the `alex-sdk-example` repository using the following command:
+```bash
+git clone https://github.com/alexgo-io/alex-sdk-example.git
+```
+Then, navigate to the project folder:
+```bash
+cd alex-sdk-example
+```
+2. **Install dependencies**
+   Install the required dependencies using Yarn:
+```
+yarn install
+```
+This will install all the necessary packages and set up the project.
+3. **Run the demo locally**
+   Start the development server with the following command:
+```
+yarn dev
+```
+The demo will now be accessible at [http://localhost:5173](http://localhost:5173) in your web browser.
+
+## Features
+
+The `alex-sdk-example` showcases the following features of the Alex SDK:
+
+- Swap Fee Calculation
+- Swap Router
+- Swap Rate
+- And perform actual swap
+
+## Documentation
+
+For more information about the Alex SDK, including detailed documentation, API references, and usage examples, please visit the official [Alex SDK documentation](https://github.com/alexgo-io/alex-sdk).
+
+## Support and Contributions
+
+If you encounter any issues or have questions, feel free to open an issue in the [Issues](https://github.com/alexgo-io/alex-sdk-example/issues) section of this repository. Contributions and improvements are always welcome. If you would like to contribute, please fork the repository and submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.