diff --git a/README.md b/README.md index 8f042650..6954fe72 100644 --- a/README.md +++ b/README.md @@ -7,50 +7,21 @@ Innovative DEX with concentrated liquidity and customizable plugins.

-Tests status -Echidna status Tests status -Tests status

-Echidna status -Echidna status Echidna status -Echidna status

- [Docs](#docs) -- [Versions](#versions) -- [Packages](#packages) - [Build](#build) - [Tests](#tests) -- [Tests coverage](#tests-coverage) -- [Deploy](#deploy) ## Docs The documentation page is located at: https://cryptoalgebra.gitbook.io/algebra-integral/ -## Versions - -Please note that different DEX-partners of our protocol may use different versions of the protocol. This repo contains the latest version: **Algebra Integral**. - -A page describing the versions used by partners can be found in the documentation: [partners page](https://docs.algebra.finance/en/docs/contracts/partners/introduction) - -Previous versions of the protocol have been moved to separate repositories: - -[Algebra V1.9](https://github.com/cryptoalgebra/AlgebraV1.9) - -[Algebra V1](https://github.com/cryptoalgebra/AlgebraV1) - -## Packages - -Core: https://www.npmjs.com/package/@cryptoalgebra/integral-core - -Periphery: https://www.npmjs.com/package/@cryptoalgebra/integral-periphery - -Basic plugin: https://www.npmjs.com/package/@cryptoalgebra/integral-base-plugin ## Build @@ -77,18 +48,3 @@ Tests for a specific module are run by the following command in the module folde $ npm run test ``` -## Tests coverage - -To get a test coverage for specific module, you need to run the following command in the module folder: - -``` -$ npm run coverage -``` - -## Deploy -Firstly you need to create `.env` file in the root directory of project as in `env.example`. - -To deploy all modules in specific network: -``` -$ node scripts/deployAll.js -``` diff --git a/src/README.md b/src/README.md deleted file mode 100644 index 266b33bb..00000000 --- a/src/README.md +++ /dev/null @@ -1,17 +0,0 @@ -Separate components of the protocol are taken out in modules. - -## Core - -The key part of the protocol, which contains the main logic of liquidity pools. Swaps, liquidity provision, flashloans and so on are implemented here. - -## Plugin - -A separate module with plugin for the Core module. With the help of replaceable plugins, the functionality of the protocol can be changed and extended. A default plugin from the Algebra protocol team is implemented here. - -## Periphery - -This module contains smart contracts that can be used by users to easily interact with the protocol. Such as swap router, position manager and so on. - -## Farming - -A separate module with onchain farming for Algebra protocol concentrated liquidity positions. diff --git a/src/plugin/brevis/README.md b/src/plugin/brevis/README.md index 33be60ad..bcb7d2b2 100644 --- a/src/plugin/brevis/README.md +++ b/src/plugin/brevis/README.md @@ -1,6 +1,4 @@ # Algebra Plugins - Tests status - Echidna status This directory contains the base Algebra protocol plugin, which combines the following functionality: - TWAP oracle @@ -8,6 +6,7 @@ This directory contains the base Algebra protocol plugin, which combines the fol - dynamic fee manager - farmings adapter + ## License Licenses for smart contracts are specified in SPDX headers. A key part of the Plugins contracts is under BUSL-1.1 (Business Source License 1.1).