Skip to content

Commit

Permalink
add main Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel authored and daniel committed Sep 9, 2024
1 parent df55a8a commit 448468c
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<p>&nbsp;</p>
<p align="center">
<img src="./assets/Euclid Readme.png" width=1000>
</p>

## Table of Contents

1. [Overview](#overview)
2. [Installation](#installation)
3. [Building the Project](#building-the-project)
4. [Running Tests](#running-tests)
5. [Contributing](#contributing)
6. [License](#license)

## Overview
Euclid is an open-source decentralized unified liquidity layer designed to allow any application to integrate into a unified source of truth. By creating a unified liquidity layer that connects blockchains, Euclid fosters a collaborative ecosystem where everyone benefits from increased liquidity, reduced slippage, and a seamless trading experience.

### Mission
Euclid's mission is to unlock the true potential of decentralized finance by empowering developers, users, and token projects with a robust, permissionless, and efficient protocol for accessing and managing liquidity across the entire blockchain space.

![Unified Liquidity](./assets/Euclid-chains.jpg)

## Installation

To get started, clone the repository and install the necessary dependencies:

```bash
git clone https://github.com/your-repo/euclid-core-contracts.git
cd euclid-core-contracts
```
## Building the Project

To build the contracts, you can run the provided build script:

```bash
./build.sh
```

## Running Tests

To run the integration tests for the contracts, use:
```bash
cargo test
```
Note: Make sure all necessary dependencies are installed before running the tests.

## Contributing

If you'd like to contribute, please follow these steps:

1. Create a new branch for your feature or bug fix
2. Make your changes
3. Test your changes thoroughly
4. Create a pull request

When creating a pull request, please use our pull [request template](https://github.com/EuclidProtocol/euclid-core-contracts/blob/add-readme/.github/PULL_REQUEST_TEMPLATE.md). This template will guide you through providing necessary information about your changes.

## LICENSE

This project is licensed under the GNU General Public License. Refer to the [LICENSE](./LICENSE) file for more details.

Binary file added assets/Euclid Readme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Euclid-chains.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 448468c

Please sign in to comment.