Merge pull request #21 from rjpence/update-readme

readme

README.md

@@ -1,19 +1,35 @@
-# 🏗 Scaffold-ETH 2
+# Daily Financial Literacy Dapp
 
-<h4 align="center">
-  <a href="https://docs.scaffoldeth.io">Documentation</a> |
-  <a href="https://scaffoldeth.io">Website</a>
-</h4>
+Financial Literacy Facilitator is a decentralized app to help motivate people to improve their knowledge of financial literacy through an incentivized revenue sharing system. Users earn points by clicking on approved links to read external content or submitting additional content on financial literacy, which will then be used to share in ad revenue generate by the site.
 
-🧪 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.
+## Roadmap
 
-⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, and Typescript.
+1. Version 1
 
-- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.
-- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
-- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.
+2. Version 2: Consuming Content
+
+3. Version 3: Proposing Content
+
+4. Version 4: Earning Points When Consuming Content
+
+5. Version 5: Distributing Awards Based on Point
+
+6. Version 6: Distributing Awards to Non-Participants
+
+7. Version 7: Introduce Epochs
+
+8. Version 8: Disincentivizing Inappropriate Content
+
+9. Version 9: Incentivizing Appropriate Content
+
+## Diagrams
+
+![Track Consumed Content](trackConsumedContent-Diagram.png)
+
+![Chainlink Functions to Validate Proposed Content with OpenAI](<Chainlink Functions Diagram Page-1-[1702243005074].png>)
+
+![Chainlink VRF to Assign Bonus Diagram](<Chainlink VRF to Assign Bonus Diagram Page-1-[1702242856182].png>)
 
-![Debug Contracts tab](https://github.com/scaffold-eth/scaffold-eth-2/assets/55535804/1171422a-0ce4-4203-bcd4-d2d1941d198b)
 
 ## Requirements
 
@@ -70,9 +86,3 @@ Run smart contract test with `yarn hardhat:test`
 Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2.
 
 To know more about its features, check out our [website](https://scaffoldeth.io).
-
-## Contributing to Scaffold-ETH 2
-
-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.