Skip to content

Commit

Permalink
Updated header for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
golden-lucky-monkey committed Apr 14, 2022
1 parent d9125d8 commit 146a5f9
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
//! A trading bot written in Rust.
//!
//! Dinesh Pinto, 2022.
//! © Dinesh Pinto, 2022
//! LICENSE: Apache-2.0, see http://www.apache.org/licenses/LICENSE-2.0
//!
//! Uses a trading strategy based on counter trading large deviations in
//! the delta volume (i.e. bid volume - ask volume) on the futures orderbook.
Expand All @@ -19,10 +20,13 @@ mod tests;
///
/// The process is:
/// 1. Set up asynchronous connection to the FTX API
/// 1. Wait for N time steps, where N is the length of the bollinger band.
/// 2. Set the trigger to ready the bot
/// 3. Enter a long/short position, with a take profit and stop loss if needed
/// 4. Monitor position and change sides if needed
/// 2. Wait for N time steps, where N is the length of the bollinger band.
/// 3. Set the trigger to ready the bot
/// 4. Enter a long/short position based on the entry conditions specified in settings
/// 5. Exit by either hitting the take profit/stop loss or by switching sides
///
/// Note: For risk management purposes, in case the bot is unable to place TP/SL after
/// opening a position it will close the open position and panic.
///
#[tokio::main]
async fn main() {
Expand Down

0 comments on commit 146a5f9

Please sign in to comment.