(docs) added template for pure-mm strategy

CoinAlpha · Apr 27, 2019 · a7b9f2c · a7b9f2c
1 parent 4ae0daa
commit a7b9f2c
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/documentation/docs/assets/img/pure-mm.png b/documentation/docs/assets/img/pure-mm.png
diff --git a/documentation/docs/strategies/pure-market-making.md b/documentation/docs/strategies/pure-market-making.md
@@ -0,0 +1,27 @@
+# Pure market making
+
+Pure market making is described in [Strategies](/strategies/), with a further discussion in the Hummingbot [white paper](https://hummingbot.io/whitepaper.pdf).
+
+!!! note
+    The pure market making strategy is currently under development and not yet available on Hummingbot.
+
+### Schematic
+
+The diagram below illustrates how market making works.  Hummingbot makes a market by placing buy and sell orders on a single exchange, specifying prices and sizes.
+
+<small><center>***Figure 1: Hummingbot makes a market on an exchange***</center></small>
+
+![Figure 1: Hummingbot makes a market on an exchange](/assets/img/pure-mm.png)
+
+## Prerequisites: Inventory
+
+1. You will need to hold inventory of quote and base currencies on the exchange.
+2. You will also need some Ethereum to pay gas for transactions on a DEX (if applicable).
+
+## Configuration walkthrough
+
+To come...
+
+## Configuration parameters
+
+To come...
diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml
@@ -102,6 +102,7 @@ nav:
       - Strategies: strategies.md
       - Cross-exchange market making: strategies/cross-exchange-market-making.md
       - Arbitrage: strategies/arbitrage.md
+      - Pure market making: strategies/pure-market-making.md
     - Support:
       - Support: support.md
       - Bug bounty program: support/bug-bounty-program.md