Merge pull request #69 from Bella-DeFinTech/main

Release v0.1.4

README.md

@@ -1,15 +1,20 @@
 [![Twitter URL](https://img.shields.io/twitter/url.svg?label=Follow%20%40BellaProtocol&style=social&url=https%3A%2F%2Ftwitter.com%2FBellaProtocol)](https://twitter.com/BellaProtocol)
-[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/V25W36sKMv)
+[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/8ctd5geS8t)
 
-# the "_Tuner_", a Uniswap V3 Simulator
+# the "_Tuner_", a programmable, transaction-based Uniswap V3 Simulator with 100% Precision
 
 > Before an ochestra, every musical instrument has to be _in-tune_, to ensure an outstanding performance.
 >
 > Before running a strategy, every parameter has to be _fine tuned_, to maximaze the performance.
 
-### _Tuner_ is a programmatic Uniswap V3 simulator that allows strategy backtesting on a transaction-to-transaction basis with arbitrary or historical data without the EVM, it runs independently yet completely retains the exact smart-contract behavior of the intricate design and implementation of Uniswap V3.
+#### _Tuner_ is a programmatic Uniswap V3 simulator that allows strategy backtesting on a transaction-to-transaction basis with arbitrary or historical data without the EVM, it runs independently yet completely retains the exact smart-contract behavior of the intricate design and implementation of Uniswap V3.
 
-## [Quick Start](https://docs.bella.fi/)
+## Documentation
+
+- [Getting Started](https://docs.bella.fi/getting-started)
+- [Configuration](https://docs.bella.fi/configuration)
+- [Guides](https://docs.bella.fi/guides)
+- Developer Articles(stay tuned)
 
 #### _Tuner_ is fundamentally a state machine, it can:
 

SUMMARY.md

@@ -0,0 +1,53 @@
+# Table of contents
+
+## Getting Started
+
+- [Overview](README.md)
+
+- [How "Tuner" Library Works?](docs/how-tuner-library-works.md)
+
+- [Installing "Tuner"](docs/installing-tuner.md)
+
+- [Quick Start](docs/quick-start.md)
+
+## Configuration
+
+- [Configuration](docs/configuration.md)
+
+## Guides
+
+- (Basic)For anyone who is interested in the Uniswap v3 model
+
+  - [Building a client instance](docs/building-a-client-instance.md)
+  - [About Core Pool Config](docs/about-core-pool-config.md)
+  - [Getting a Core Pool instance](docs/getting-a-core-pool-instance.md)
+  - [Interacting with Core Pool](docs/interacting-with-core-pool.md)
+
+- (Typical)For a quant developer who works on a real pool on mainnet
+
+  - [Fetching all the data of a certain pool from Ethereum](docs/fetching-all-the-data-of-a-certain-pool-from-ethereum.md)
+  - [Getting a pool instance with the data fetched](docs/getting-a-pool-instance-with-the-data-fetched.md)
+
+- (Advanced)For a better user experience as a state machine
+
+  - [PoolState & Transition](docs/pool-state-and-transition.md)
+  - [Post-processor](docs/post-processor.md)
+  - [Forking & Retracing](docs/forking-and-retracing.md)
+  - [Persisting & Recovering](docs/persisting-and-recovering.md)
+  - [SimulatorRoadmapManager](docs/simulator-roadmap-manager.md)
+
+## Performance
+
+- [Performance](docs/performance.md)
+
+## Examples
+
+- [Uniswap-v3-Events-Downloader](https://github.com/Bella-DeFinTech/uniswap-v3-simulator/tree/main/examples/Uniswap-v3-Events-Downloader)
+
+- [Uniswap-v3-Strategy-Backtest](https://github.com/Bella-DeFinTech/uniswap-v3-simulator/tree/main/examples/Uniswap-v3-Strategy-Backtest)
+
+- Uniswap-v3-Risk-Analysis(for some reason, not published yet)
+
+## Contributing
+
+- [Contributing](docs/contributing.md)