fix: update readme

Author: gakonst

README.md

@@ -18,7 +18,7 @@ Optional arguments:
 ```
 
 Your contracts config file should be in the following format where `uniswap` is the
-UniswapV2 WETH/DAI pair and `flashloan` is the [Flash.sol](./Flash.sol) contract.
+UniswapV2 WETH/DAI pair and `flashloan` is the [Flash](./Flash.sol) contract.
 
 ```
 {
@@ -29,7 +29,28 @@ UniswapV2 WETH/DAI pair and `flashloan` is the [Flash.sol](./Flash.sol) contract
 }
 ```
 
-## Demo
+## Building and Running
+
+```
+cargo build --release
+./target/release/yield-liquidator \
+    --config ./addrs.json \
+    --private-key ./private_key \
+    --url wss://kovan.infura.io/ws/v3/fd8b88b56aa84f6da87b60f5441d6778 \
+    --interval 7000 \
+    --file state.json \
+```
+
+## How it Works
+
+On each block:
+1. Checks if any of our submitted transactions have been mined
+2. Updates our dataset of borrowers debt health & liquidation auctions with the new block's data
+3. Trigger the auction for any undercollateralized borrowers
+4. Try participating in any auctions which are worth buying
+
+
+## Testing
 
 ### Local Testnet
 
@@ -47,10 +68,16 @@ In another terminal, deploy the contracts: `npx truffle migrate --reset`
 
 This deploys MakerDAO, Yield, UniswapV2, [Multicall](https://github.com/makerdao/multicall) and the Flashloan contract.
 
-Now we run the liquidator (the Multicall address must be provided explicitly):
+Now we run the liquidator as before, by also including the `multicall` contract's address:
 
 ```
-RUST_LOG=yield_liquidator=trace cargo run -- --multicall D1Ed8059452f26360ba3DbD423cBfC955e9518cC
+{
+   "controller" : "0xd160C973a098608e2D7d6E43C64Eee48766800D1",
+   "liquidations" : "0xbC0200F0AAD7C1c0bBB1CC7885E1e796DFFac3e0",
+   "uniswap": "0xbC0200F0AAD7C1c0bBB1CC7885E1e796DFFac3e0",
+   "flashloan": "0xbC0200F0AAD7C1c0bBB1CC7885E1e796DFFac3e0"
+   "multicall": "0xbC0200F0AAD7C1c0bBB1CC7885E1e796DFFac3e0"
+}
 ```
 
 Finally, you can create a liquidation opportunity by running `npx truffle exec scripts/create_liquidation_opportunity.js`.
@@ -98,16 +125,4 @@ Finally, you can create a liquidation opportunity by running:
 ./src/set_eth_price.js 175
 ```
 
-## How it Works
-
-On each block:
-1. Checks if any of our submitted transactions have been mined
-2. Updates our dataset of borrowers debt health & liquidation auctions with the new block's data
-3. Trigger the auction for any undercollateralized borrowers
-4. Try participating in any auctions which are worth buying
-
 ## Known Bugs
-
-1. receipt & unknown decoding from RPC?
-2. too low nonce when used from the outside
-3. how to find uniswap situation. should price go up or down? how do we know? replace error with proper warning