Skip to content
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.

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

add install instructions #150

Merged
merged 1 commit into from
Nov 2, 2024
Merged
Changes from all commits
Commits
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
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ This project is a work in progress and has been tested with TWS version 10.19. T

If you encounter a problem or require a missing feature, please check the [issues list](https://github.com/wboayue/rust-ibapi/issues) before reporting a new one.

## Install

Run the following Cargo command in your project directory:

```bash
cargo add ibapi
```

Or add the following line to your Cargo.toml:

```toml
ibapi = "0.5.0"
```

## Examples

The following examples demonstrate how to use the key features of the API.
Expand Down Expand Up @@ -155,7 +169,7 @@ fn main() {

// when your algorithm is done, cancel subscription
subscription_aapl.cancel().expect("cancel failed");
subscription_nvda.cancel().expect("cancel failed");
subscription_nvda.cancel().expect("cancel failed");
}
}
```
Expand Down
Loading