From 9b8310b54292fd6dd72f55108d065364ab83c4fb Mon Sep 17 00:00:00 2001 From: Chris Sellers Date: Sat, 11 Jan 2025 12:08:15 +1100 Subject: [PATCH] Refine README and overview --- README.md | 6 +++--- docs/concepts/overview.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c769b295780..7f7510046d0 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ highest level, with the aim of supporting Python-native, mission-critical, tradi and live deployment workloads. The platform is also universal and asset-class-agnostic — with any REST, WebSocket or FIX API able to be integrated via modular -adapters. It supports high-frequency trading operations across a wide range of asset classes and instrument types +adapters. It supports high-frequency trading across a wide range of asset classes and instrument types including FX, Equities, Futures, Options, Crypto and Betting, enabling seamless operations across multiple venues simultaneously. ## Features @@ -330,7 +330,7 @@ A `Makefile` is provided to automate most installation and build tasks for devel > [!TIP] > -> Running `make build-debug` to compile after changes to Rust or Cython code is currently the most efficient workflow when developing. +> Run `make build-debug` to compile after changes to Rust or Cython code for the most efficient development workflow. ## Examples @@ -389,7 +389,7 @@ See the [Developer Guide](https://nautilustrader.io/docs/latest/developer_guide/ > [!TIP] > -> Rust tests will only pass when run via `cargo-nextest`. +> Run Rust tests with `make cargo-test`, as they only pass via **cargo-nextest**. ## Contributing diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md index 1bd55e07c3f..58b5ff3f819 100644 --- a/docs/concepts/overview.md +++ b/docs/concepts/overview.md @@ -15,7 +15,7 @@ highest level, with the aim of supporting Python-native, mission-critical, tradi and live deployment workloads. The platform is also universal and asset-class-agnostic — with any REST, WebSocket or FIX API able to be integrated via modular -adapters. It supports high-frequency trading operations across a wide range of asset classes and instrument types +adapters. It supports high-frequency trading across a wide range of asset classes and instrument types including FX, Equities, Futures, Options, Crypto and Betting, enabling seamless operations across multiple venues simultaneously. ## Features