diff --git a/README.md b/README.md index fa72ba7..1b3ec54 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,17 @@ ![visitors](https://visitor-badge.laobi.icu/badge?page_id=arena-rs.arena) [![Twitter Badge](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/anthiasxyz) +![Telegram badge](https://img.shields.io/badge/chat-Discuss-blue?logo=telegram&style=flat-square&link=https://t.me/+U043cjuV5lA2ZDQ8) +![Github Actions](https://github.com/arena-rs/arena/workflows/lint/badge.svg) + ![image](https://github.com/arena-rs/.github/blob/main/arena_banner.png) > *Arena is a powerful and extensible framework for holistic economic modelling and simulation of Uniswap v4 strategies, hooks and pools.* Track how metrics evolve over time, and over various market conditions. +Arena has an [examples](https://github.com/arena-rs/arena/tree/main/examples) folder on how to use the framework. + ## Overview Arena introduces a novel approach to LP simulation through a highly-configurable event-driven runtime. Each event consists of integral market information for a strategy, from which the actor can derive insight from. @@ -66,4 +71,6 @@ git submodule update --init --recursive - Explore the documentation for detailed usage instructions. - Check out example strategies in the `examples/` directory. -We welcome contributions! \ No newline at end of file +We welcome contributions! + +See our [Contributing Guidelines](https://github.com/arena-rs/arena/blob/main/CONTRIBUTING.md)