Skip to content

Commit a255b96

Browse files
Update Project URLs (#2)
* Add project urls * Fix typos * Fix formatting
1 parent 07b584e commit a255b96

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Bourse
22

3-
Rust market-simulator with Python API
3+
Rust market-simulator with a Python API
44

55
## Python
66

7+
Full documentation can be found
8+
[here](https://zombie-einstein.github.io/bourse/).
9+
710
### Getting Started
811

912
Bourse can be installed via pip
@@ -14,17 +17,23 @@ pip install bourse
1417

1518
### Examples
1619

17-
See [here](examples/) for simulation examples.
20+
See [here](examples/) for simulation examples and
21+
[the docs](https://zombie-einstein.github.io/bourse/pages/example.html)
22+
for an annotated example.
1823

1924
## Rust
2025

2126
### Getting Started
2227

23-
The library consists of two core
24-
crates:
28+
The library consists of two core crates:
29+
30+
- `bourse-book` a library implementing a market order
31+
book. Full documentation can be found
32+
[here](https://docs.rs/bourse-book/0.1.0/bourse_book/).
2533

26-
- `bourse-book` an library implementing an market order book
27-
- `bourse-de` a discrete-event market simulation library
34+
- `bourse-de` a discrete-event market simulation library.
35+
Full documentation can be found
36+
[here](https://docs.rs/bourse-de/0.1.0/bourse_de/)
2837

2938
Both can be installed using cargo
3039

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ dependencies = [
3434
]
3535

3636
[project.urls]
37-
Source = "https://github.com/zombie-einstein/bourse"
37+
source = "https://github.com/zombie-einstein/bourse"
38+
docs = "https://zombie-einstein.github.io/bourse/"
39+
documentation = "https://zombie-einstein.github.io/bourse/"
3840

3941
[tool.hatch.envs.dev]
4042
dependencies = [

0 commit comments

Comments
 (0)