Skip to content

docs: improve README #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Hyperliquid Backtester

[![Crates.io](https://img.shields.io/crates/v/hyperliquid-backtest.svg)](https://crates.io/crates/hyperliquid-backtest)
Expand Down Expand Up @@ -32,7 +34,7 @@ Add this to your `Cargo.toml`:

```toml
[dependencies]
hyperliquid-backtest = "0.1.1"
hyperliquid-backtest = "0.1.2"
tokio = { version = "1.0", features = ["full"] }
chrono = { version = "0.4", features = ["serde"] }
```
Expand Down Expand Up @@ -376,7 +378,7 @@ This crate follows [Semantic Versioning (SemVer)](https://semver.org/):
- **Minor version** (0.1.x → 0.2.0): New features, backward compatible
- **Patch version** (0.1.0 → 0.1.1): Bug fixes, backward compatible

**Current version: 0.1.1** (Pre-1.0 development phase)
**Current version: 0.1.2** (Pre-1.0 development phase)

### Stability Guarantees

Expand Down Expand Up @@ -574,4 +576,4 @@ This software is for educational and research purposes only. Trading cryptocurre

- **Issues**: [GitHub Issues](https://github.com/xsa-dev/hyperliquid-backtest/issues)
- **Discussions**: [GitHub Discussions](https://github.com/xsa-dev/hyperliquid-backtest/discussions)
- **Documentation**: [docs.rs](https://docs.rs/hyperliquid-backtest)
- **Documentation**: [docs.rs](https://docs.rs/hyperliquid-backtest)