diff --git a/README.md b/README.md index 6ee604039..0ee3e2c32 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,7 @@ In a future version, we plan to address this by routing ETH and token contributi - [Deployment](docs/deployment.md) - [Providing matching funds](docs/funding-source.md) - [How to tally votes and verify results](docs/tally-verify.md) +- [How to donate to projects](docs/howto-use-app.md) - [Running the subgraph](docs/subgraph.md) - [Sitemap](docs/sitemap.md) - [Website theme and customization](docs/theme.md) diff --git a/docs/howto-use-app.md b/docs/howto-use-app.md new file mode 100644 index 000000000..a48935190 --- /dev/null +++ b/docs/howto-use-app.md @@ -0,0 +1,62 @@ +# How to use the CLR.fund app + +## What you'll need +1. ETH + + > For testing, + - Get Goerli ETH from [Unitap](https://unitap.app/gas-tap) + - Use the [bridge](https://bridge.arbitrum.io/?l2ChainId=421613) to convert to Arbitrum Goerli ETH + +2. Contribution tokens + + > For testing, mint the DAI tokens using the `mint()` function from the [etherscan contract page](https://goerli.arbiscan.io//address/0x65bc8dd04808d99cf8aa6749f128d55c2051edde#writeContract) with the follow inputs: + + - usr (address): Your wallet address + - wad (uint256): How many DAI tokens to mint, e.g. 20000000000000000000 is 20 DAI + +Note, all the links provided below are from our test site for testing and illustration purposes only. For production, please replace https://clrfund-testnet.netlify.app with https://clr.fund + +## How to add your project as a fund recipient + + - Goto https://clrfund-testnet.netlify.app/#/join to submit your project + - Once your project is approved, it will show up on the project page and start receiving donations + - To check your project status, goto https://clrfund-testnet.netlify.app/#/recipients + +## How to contribute to projects +1. Register as a contributor + - Verify with [BrightID](https://www.brightid.org) + - Goto https://clrfund-testnet.netlify.app/#/verify to get registered + + + + +https://github.com/clrfund/monorepo/assets/18424940/c0a995f8-1835-4de3-b6ee-ccfbe32e52b4 + + + + +2. Contribute to projects + - Goto https://clrfund-testnet.netlify.app/#/projects to contribute to projects + + + +https://github.com/clrfund/monorepo/assets/18424940/9b50acbf-ca43-454f-be88-4c52058669ad + + + + +3. Reallocate contributions + - Goto https://clrfund-testnet.netlify.app/#/projects to change your contribution allocations + + + +https://github.com/clrfund/monorepo/assets/18424940/43188b69-9ece-4c2e-9ecc-babc1cdc09a3 + + + +## Bug report +You can report any issues with one of the following ways: +1. Report any issues in the `support` channel of the [CLR.fund discord](https://discord.gg/ZnsYPV6dCv) +2. Open a github issue on https://github.com/clrfund/monorepo/issues + + diff --git a/docs/videos/contribute.mp4 b/docs/videos/contribute.mp4 new file mode 100644 index 000000000..af218a8c8 Binary files /dev/null and b/docs/videos/contribute.mp4 differ diff --git a/docs/videos/reallocate.mp4 b/docs/videos/reallocate.mp4 new file mode 100644 index 000000000..4d8aaecc8 Binary files /dev/null and b/docs/videos/reallocate.mp4 differ diff --git a/docs/videos/register.mp4 b/docs/videos/register.mp4 new file mode 100644 index 000000000..113b4ba3e Binary files /dev/null and b/docs/videos/register.mp4 differ