doc: Update readme

README.md

@@ -1,9 +1,16 @@
-# initial-farm-offering
+# Initial Ape Offering
 
-[![Actions Status](https://github.com/pancakeswap/inital-farm-offering/workflows/CI/badge.svg)](https://github.com/pancakeswap/inital-farm-offering/actions)
+[![Actions Status](https://github.com/ApeSwapFinance/apeswap-iao/workflows/CI/badge.svg)](https://github.com/ApeSwapFinance/apeswap-iao/actions)
 
+This set of contracts is used to run Ape Swap's version of initial farm offerings.  
 
-# Local Development
+## Operation
+- Each IAO raises a predefined `stakeToken` amount in exchange for a predefined `offeringToken` amount
+- Once the `startBlock` arrives, users can supply as much of the raising token as they would like 
+- Once the `endBlock` arrives, users can withdraw their tokens from the IAO
+- `offeringTokens` are sent to the users based on the percentage of their allocation and a refund of `stakeTokens` when there is an oversubscription of the IAO 
+
+# Development
 
 The following assumes the use of `node@>=12`.
 
@@ -15,6 +22,15 @@ The following assumes the use of `node@>=12`.
 
 `yarn compile`
 
+## Migrate Contracts
+Create a file named `.env` in the root project directory and copy in the variables from `.env.example`. Provide variables for each relevant item.  
+
+To deploy to BSC mainnet:   
+`yarn migrate:bsc`    
+
+To deploy to BSC Testnet:  
+`yarn migrate:testnet`  
+
 ## Run Tests
 
 `yarn test`