Skip to content

Commit

Permalink
WIP: Add upcoming sections to getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
rupurt committed Jul 29, 2021
1 parent 5fb5a29 commit 1507717
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

[Getting Started](./GETTING_STARTED.md) | [Built with Tai](./BUILT_WITH_TAI.md) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md)

## Tai Components & Data Flow

* Coming soon...

## Orders

![Order States](./architecture/order-states.png)
Expand Down
24 changes: 24 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@

* [https://github.com/fremantle-industries/tai/blob/main/docs/ARCHITECTURE.md#tai-components--data-flow](https://github.com/fremantle-industries/tai/blob/main/docs/ARCHITECTURE.md#tai-components--data-flow)

## Daily Developer Workflow

* Coming soon...

## Mapping Tai to OTP Concepts

* Coming soon...

## Streaming Order Book & Trade Data to Advisors

* [https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/log_spread](https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/log_spread)
Expand All @@ -49,6 +57,14 @@

* [https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/ping_pong](https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/ping_pong)

## Receiving Custom Data in Advisors

* Coming soon...

## Testing Advisors

* Coming soon...

## Create and Test a New Venue Adapter

* Create or use an [existing Elixir client library](https://github.com/fremantle-industries/ex_ftx) for the venue. This will help with mocks when testing.
Expand All @@ -63,3 +79,11 @@
* Implement [amend bulk orders](.) if the venue supports changing multiple orders in place
* Configure the new venue for [market data streaming](.)
* Configure the [account credentials](.) to receive balances and manage orders

## Coordinate Multiple Instances of Tai within an OTP Distribution Cluster

* Coming soon...

## Build an OTP Release and Deploy to the Cloud

* Coming soon...

0 comments on commit 1507717

Please sign in to comment.