Skip to content

Commit ab23d77

Browse files
committed
Basic doc structure
1 parent 9da41fb commit ab23d77

File tree

17 files changed

+481
-9
lines changed

17 files changed

+481
-9
lines changed

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
Lucky is a trading framework for Julia designed to
77

8-
- (very) rapidly test and deploy trading statregies with next to zero code change between the two.
9-
- run very fast by leveraging Julia's multiple dispatch paradigm and [Rocket.jl](https://github.com/ReactiveBayes/Rocket.jl) as its **asynchronous** and **reactive** core.
10-
- being super simple to start with and modular to tailor and extend to different needs.
8+
- rapidly test and deploy trading statregies with next to zero code change between the two.
9+
- run fast by leveraging Julia's multiple dispatch paradigm and [Rocket.jl](https://github.com/ReactiveBayes/Rocket.jl) as its **asynchronous** and **reactive** core.
10+
- being super simple to start with although remaining modular to tailor and extend to different needs.
1111
- accomodate different kind of strategies, data or experiements (market making, random process simulation, etc.) leveraging Julia's powerful math libraries ecosystem.
1212

1313
## Example code
@@ -16,20 +16,17 @@ A documented and working example is available in the examples folder [here](http
1616

1717
## Integrations
1818

19-
Lucky.jl is designed to be extendable to any API data source (including brokers) and/or data types.
19+
Lucky.jl is designed to be extendable to any API data source (brokers, exchanges, etc.) and/or data types.
2020

2121
At the day of writing, the libray integrates the following integrations:
2222

2323
| Library | Type | Comments |
2424
|--------------------------------------------------------------|-------------------------------------------------------------------|------------------------------------------------|
25-
| [MarketData.jl](https://github.com/JuliaQuant/MarketData.jl) | Historical financial time series from Yahoo, FRED, ONS. | - Yahoo :heavy_check_mark:|
25+
| [MarketData.jl](https://github.com/JuliaQuant/MarketData.jl) | Historical financial time series from Yahoo, FRED, ONS. | :heavy_check_mark:|
2626
| [TimeSeries.jl](https://github.com/JuliaStats/TimeSeries.jl) | Lightweight framework for working with time series data in Julia. | :heavy_check_mark: |
27-
| [InteractiveBrokers.jl](https://github.com/oliviermilla/InteractiveBrokers.jl) | Pure Julia API to Interactive Brokers | :heavy_check_mark: Partial |
27+
| [InteractiveBrokers.jl](https://github.com/oliviermilla/InteractiveBrokers.jl) | Pure Julia API to Interactive Brokers | :heavy_check_mark: (partial) |
2828
| Random | Standard Julia Random Library | :heavy_check_mark: |
2929

30-
## Data Types
31-
The library provides interface to handle Open High Low Close data (if that's what you're into).
32-
3330
**The library is in development. Contact if you'd like to help.**
3431

3532
# What's with the name ?

docs/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build/
2+
site/

0 commit comments

Comments
 (0)