Skip to content

Commit 663f9b2

Browse files
committed
docs: fix link in readme
1 parent c32bed1 commit 663f9b2

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Ultra-fast matching engine written in TypeScript
1717

1818
- Standard price-time priority
1919
- Supports both market and limit orders
20-
- Supports conditional orders [**Stop Limit, Stop Market and OCO**](#conditional-orders-static-badge) ![Static Badge](https://img.shields.io/badge/Experimental-blue)
20+
- Supports conditional orders [**Stop Limit, Stop Market and OCO**](#conditional-orders-experimental) <img src="https://img.shields.io/badge/Experimental-blue" alt="Experimental">
2121
- Supports time in force GTC, FOK and IOC
2222
- Supports order cancelling
2323
- Supports order price and/or size updating
@@ -65,8 +65,8 @@ ob.modify(orderID: string, { side: 'buy' | 'sell', size: number, price: number }
6565

6666
ob.cancel(orderID: string)
6767
```
68-
### Conditional Orders ![Static Badge](https://img.shields.io/badge/Experimental-blue)
69-
The version `v6.1.0` introduced support for Conditional Orders (`Stop Market`, `Stop Limit` and `OCO`). Even though the test coverage for these new features is at 100%, they are not yet considered stable because they have not been tested with real-world scenarios. For this reason, if you want to use conditional orders, you need to instantiate the order book with the `experimentalConditionalOrders` option set to `true`.
68+
### Conditional Orders ![Experimental](https://img.shields.io/badge/Experimental-blue)
69+
The version `v6.1.0` introduced support for Conditional Orders `Stop Market`, `Stop Limit` and `OCO`. Even though the test coverage for these new features is at 100%, they are not yet considered stable because they have not been tested with real-world scenarios. For this reason, if you want to use conditional orders, you need to instantiate the order book with the `experimentalConditionalOrders` option set to `true`.
7070
```js
7171
import { OrderBook } from 'hft-limit-order-book'
7272

0 commit comments

Comments
 (0)