diff --git a/README.md b/README.md index 2a6e80e..5054fae 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,55 @@ # Mainnet to Testnet Bridge -Mainnet to Testnet Bridge creates a market on both testnets and mainnets for native gas tokens. +## Overview +The Mainnet to Testnet Bridge is a tool designed for the transfer of native gas tokens between mainnet and testnet environments. It facilitates the creation of a market for these tokens across both networks, serving the needs of developers and users involved in blockchain testing and development. -## Getting Started - -### Setup - -- Clone the repository -- run `yarn` +## Features +- **Token Bridging**: Enables the transfer of native gas tokens between mainnet and testnet. +- **Market Support**: Assists in establishing a market for gas tokens on both networks. +- **Development Utility**: Aids in the testing and development process by providing a mechanism for token transfer. -### Test - -`yarn test` - -Run the full suite of unit tests. +## Getting Started -### Coverage +### Prerequisites +Ensure you have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed on your system to work with the project and run the commands detailed below. -`yarn coverage` +### Setup +1. **Clone the repository** to your local machine using Git: + ``` + git clone https://github.com/LayerZero-Labs/mainnet-testnet-bridge.git + ``` +2. **Navigate** into the cloned repository directory: + ``` + cd mainnet-testnet-bridge + ``` +3. **Install dependencies** using Yarn: + ``` + yarn + ``` + +### Usage + +#### Testing +To execute the unit tests, run: +``` +yarn test +``` +This command executes the test suite to verify functionality across various scenarios. + +#### Coverage Report +For a coverage report, run: +``` +yarn coverage +``` +The coverage report evaluates the extent to which the tests cover the codebase. + +## Contributing +Contributions are welcome. This includes bug reports, feature proposals, and code submissions. Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for our code of conduct and submission process. + +## License +This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details. + +## Support +For questions or more information, refer to [our website](https://layerzero.network/) or join [our Discord channel](https://discord.gg/layerzero). -Get the coverage report.