updated readme

README.md

@@ -1,4 +1,59 @@
-# 🏗 Scaffold-ETH 2
+# Reputation & Roles
+
+An open-source toolkit used to quickly and easily deploy your own Reputation & Roles smart contracts along with a decentralized application to interact with them.
+
+## Quickstart
+
+To get started with Reputation & Roles, follow the steps below:
+
+1. Clone this repo & install dependencies
+
+```
+git clone https://github.com/atxdao/reputation-and-roles-monorepo.git
+cd reputation-and-roles-monorepo
+yarn install
+```
+
+1. On the first terminal, start your NextJS app:
+
+```
+yarn start
+```
+
+Visit your app on: `http://localhost:3000`.
+
+Connect a burner wallet.
+Copy the wallet address.
+Return to your code editor, navigate to `~/packages/foundry/script/DeployDemo.s.sol`, and replace the value of the `controller` variable with your copied wallet address.
+
+
+2. Run a local network on your second terminal:
+
+```
+yarn chain
+```
+
+This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development.
+
+3. On a third terminal, deploy the test contract:
+
+```
+yarn deployDemo
+```
+
+This command deploys a test smart contract to the local network. The contract is located in `packages/foundry/lib/reputation/src/ReputationTokensStandalone`.
+The `yarn deploy` command uses the deploy script located in `packages/foundry/script/DeployDemo.s.sol` to deploy the contract to the network. You can also customize the deploy script.
+
+4. View results on webpage
+
+Re-visit your app on: `http://localhost:3000`.
+Refresh the page if you need to!
+
+On the home page, you should see many colorful and variable cards and widgets which display your Reputation Tokens in full force!
+By navigating to the `Debug Contracts` page, you can interact with and view the properties of your deploy Reputation system!
+
+
+<!-- # 🏗 Scaffold-ETH 2
 
 🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
 
@@ -315,4 +370,4 @@ We welcome contributions to Scaffold-ETH 2!
 Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.
 
 
-Valid `CreateToken` parameters in debug window: `{ "maxMintAmountPerTx": "0x16", "isTradeable": true }`
+Valid `CreateToken` parameters in debug window: `{ "maxMintAmountPerTx": "0x16", "isTradeable": true }` -->