Skip to content

Commit

Permalink
Update README and integration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Mar 22, 2024
1 parent 6d1eb12 commit 6c315af
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ This project makes the [Soundness Pledge](https://raphlinus.github.io/rust/2020/
## Integrations

NautilusTrader is designed in a modular way to work with _adapters_ which provide
connectivity to trading venues and/or data providers - converting their raw API
connectivity to trading venues and data providers - converting their raw API
into a unified interface. The following integrations are currently supported:

| Name | ID | Type | Status | Docs |
Expand All @@ -157,9 +157,7 @@ into a unified interface. The following integrations are currently supported:
- `beta` - Completed to a minimally working state and in a 'beta' testing phase
- `stable` - Stabilized feature set and API, the integration has been tested by both developers and users to a reasonable level (some bugs may still remain)

```{note}
Refer to the [Integrations](https://docs.nautilustrader.io/integrations/index.html) documentation for further details.
```

## Installation

Expand Down
11 changes: 2 additions & 9 deletions docs/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,12 @@
binance.md
databento.md
ib.md
```

NautilusTrader is designed in a modular way to work with 'adapters' which provide
connectivity to data providers and/or trading venues - converting their raw API
NautilusTrader is designed in a modular way to work with *adapters* which provide
connectivity to trading venues and data providers - converting their raw API
into a unified interface. The following integrations are currently supported:

```{warning}
The initial integrations for the project are currently under heavy construction.
It's advised to conduct some of your own testing with small amounts of capital before
running strategies which are able to access larger capital allocations.
```

| Name | ID | Type | Status | Docs |
| :-------------------------------------------------------- | :-------------------- | :---------------------- | :------------------------------------------------------ | :------------------------------------------------------------------ |
| [Betfair](https://betfair.com) | `BETFAIR` | Sports Betting Exchange | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/betfair.html) |
Expand Down

0 comments on commit 6c315af

Please sign in to comment.