Skip to content

Commit e2894aa

Browse files
committed
updated README.md
1 parent ed2493a commit e2894aa

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
1-
# RUSTQuant :Pricing Options with Confidence
2-
RustQuant is a lightweight yet robust quantitative finance library designed for pricing options.
1+
[![Rust](https://github.com/siddharthqs/RustyQLib/actions/workflows/rust.yml/badge.svg)](https://github.com/siddharthqs/RustyQLib/actions/workflows/rust.yml)
2+
3+
# RUSTYQLib :Pricing Options with Confidence using JSON
4+
RustyQLib is a lightweight yet robust quantitative finance library designed for pricing options.
35
Built entirely in Rust, it offers a unique combination of safety, performance, and expressiveness that is crucial
4-
for handling financial data and complex calculations. RustQuant simplifies equity option pricing without compromising
6+
for handling financial data and complex calculations. RustyQlib simplifies equity option pricing without compromising
57
on safety, speed, or usability.
68
## License
7-
RustQuant is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
9+
RustyQlib is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
810
See LICENSE-APACHE and LICENSE-MIT for details.
911
## Running
1012
After cloning the repository and building you can run the following command:
1113
```bash
12-
derivatives file --input <FILE> --output <FILE>
14+
rustyqlib file --input <FILE> --output <FILE>
1315
````
1416
and for pricing all contracts in a directory
1517
```bash
16-
derivatives dir --input <DIR> --output <DIR>
18+
rustyqlib dir --input <DIR> --output <DIR>
1719
```
1820
and for interactive mode
1921
```bash
20-
derivatives interactive
22+
rustyqlib interactive
23+
```
24+
and for build mode to build vol surface or interest rate curve
25+
```bash
26+
rustyqlib build --input <FILE> --output <DIR>
2127
```
22-
2328
Sample input file is provided in the repository (src\input\equity_option.json)
2429
Files are in JSON format and can be easily edited with any text editor.
2530
## Features

0 commit comments

Comments
 (0)