Skip to content

Commit 562f85c

Browse files
committed
docs: update license on readme
1 parent 4dc7439 commit 562f85c

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@ Improved matching engine written in Javascript
1717
## Installation
1818

1919
Install with npm:
20+
2021
```sh
2122
npm install hft-limit-order-book --save
2223
```
24+
2325
Install with yarn:
26+
2427
```sh
2528
yarn add hft-limit-order-book
2629
```
@@ -30,9 +33,9 @@ yarn add hft-limit-order-book
3033
To start using order book you need to import `OrderBook` and create new instance:
3134

3235
```js
33-
import { OrderBook } from "hft-limit-order-book";
36+
import { OrderBook } from 'hft-limit-order-book'
3437

35-
const lob = new OrderBook();
38+
const lob = new OrderBook()
3639
```
3740

3841
Then you be able to use next primary functions:
@@ -70,6 +73,7 @@ processLimitOrder(side: 'buy' | 'sell', orderID: string, size: number, price: nu
7073
```
7174

7275
For example:
76+
7377
```
7478
processLimitOrder("sell", "uinqueID", 55, 100);
7579
@@ -133,6 +137,7 @@ processMarketOrder(side: 'buy' | 'sell', size: number);
133137
```
134138

135139
For example:
140+
136141
```
137142
processMarketOrder('sell', 6);
138143
@@ -156,7 +161,7 @@ asks: 110 -> 5
156161
-------------- -> --------------
157162
bids: 90 -> 5 90 -> 5
158163
80 -> 1 80 -> 1
159-
164+
160165
done - 2 (or more orders)
161166
partial - nil
162167
quantityLeft - 4
@@ -178,12 +183,13 @@ asks: 110 -> 5
178183
-------------- -> --------------
179184
bids: 90 -> 5 90 -> 5
180185
80 -> 1 80 -> 1
181-
186+
182187
done - 2 (or more orders)
183188
partial - nil
184189
quantityLeft - 4
185190
186191
```
192+
187193
## Contributing
188194

189195
I would greatly appreciate any contributions to make this project better. Please make sure to follow the below guidelines before getting your hands dirty.
@@ -196,6 +202,4 @@ I would greatly appreciate any contributions to make this project better. Please
196202

197203
## License
198204

199-
hft-limit-order-book is [MIT licensed](LICENSE).
200-
201-
See [LICENSE](LICENSE) and [AUTHORS](AUTHORS) files
205+
Copyright [Andrea Fassina](https://github.com/fasenderos), Licensed under [MIT](LICENSE).

0 commit comments

Comments
 (0)