Skip to content

Commit a688a87

Browse files
committed
update readme
1 parent 6e2d73d commit a688a87

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
## QuantLibNode [![npm version](https://badge.fury.io/js/quantlib.svg)](http://badge.fury.io/js/quantlib)
2-
3-
QuantLib Async Bindings for Node.js
1+
## QuantLib Async Bindings for Node.js [![npm version](https://badge.fury.io/js/quantlib.svg)](http://badge.fury.io/js/quantlib)
42

53
This project brings [QuantLib](http://quantlib.org/) to the Node.js community, it's similar to [QuantLibXL](http://quantlib.org/quantlibxl/) project which is for Microsoft Excel.
64

75
Most functions in QuantLibXL can be used in the similar way in Node on the server side.
86

9-
All functions in this project are Async, they are exported to Promise sytle functions, please see [Example](#Example) below.
7+
All functions in this project are Async, they are exported to [Promise](https://www.promisejs.org/) sytle function, please see [Example](#example) below.
108

119

1210
## Getting started
@@ -17,11 +15,11 @@ npm install quantlib
1715

1816
* Windows
1917

20-
`npm install quantlib` will do everything, including the package and pre-built native addon
18+
`npm install quantlib` will do everything, including the node package installation and pre-built native addon (no dependency) download, you can start use it right away.
2119

2220
* Linux & Mac
2321

24-
Quantlib and QuantLibAddin must be built first, then build QuantLibNode linking to them
22+
Quantlib and QuantLibAddin must be built first, then build QuantLibNode linking to them, pre-built native code is not provided for now
2523

2624

2725
## QuantLib Documents
@@ -32,9 +30,9 @@ Quantlib and QuantLibAddin must be built first, then build QuantLibNode linking
3230

3331
## Version Matrix
3432

35-
| QuantLib | QuantLibAddin | Node.js | QuantLibNode |
36-
| -------- | ------------- | ------- | ------------ |
37-
| 1.7.1 | 1.7.0 | 6.9.1 | 0.1.x |
33+
| QuantLib | QuantLibAddin | Node.js | quantlib.node |
34+
| -------- | ------------- | ------- | ------------- |
35+
| 1.7.1 | 1.7.0 | 6.9.1 | 0.1.x |
3836

3937
## Example
4038

0 commit comments

Comments
 (0)