diff --git a/README - Old.md b/README - ScafoldEth.md similarity index 100% rename from README - Old.md rename to README - ScafoldEth.md diff --git a/README.assets/badge.svg b/README.assets/badge.svg deleted file mode 100644 index 8e6a184f..00000000 --- a/README.assets/badge.svg +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - - - Continuous Integration - - - Continuous Integration - - - - - - passing - - - passing - - - - - diff --git a/README.md b/README.md index 2d04a7eb..c9b2d8c2 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,53 @@ -# 🌟 Quests +## 🌟 Quests -[![Continuous Integration](README.assets/badge.svg)](https://github.com/1Hive/quests/actions/workflows/continuous-integration.yml) +[![Continuous Integration](https://github.com/1Hive/quests/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/1Hive/quests/actions/workflows/continuous-integration.yml) -## Links - -Kanban board : https://app.zenhub.com/workspaces/quests-6092dda4c272a5000e858266/board - -Discord : 1Hive (Quest Swarm channel) - -Deployed app : https://quests-d1u7l8p9l-1hive.vercel.app/ +Quests is a bounty board for 1Hive swarms. ## Setup & Launch -1. Clone - - > git clone https://github.com/1Hive/quests.git +Clone the repository -2. Install +```sh +git clone git@github.com:1hive/quests +``` - > yarn install +Install the dependencies -3. a. Launch with **Rinkeby** test network +```sh +yarn +``` - > yarn start +Start the project - b. Launch with local chain +```sh +# Rinkeby testnet +yarn start +# Local chain +yarn start:local &; yarn chain &; yarn deploy & +``` - > yarn start:local - > - > [new terminal] - > - > yarn chain - > - > [new terminal] - > - > yarn deploy:local +### Docs -## Doc - -### Anonymous features +#### Anonymous features - Browse quests - Filter Quests -### Account connected features +#### Account connected features - Play quest - Create quest - Fund quest -### Connect +#### Connect 1. Select xDai chain 2. Click Enable Button account 3. Click on Metamask button -4. You can now : - 1. Create a quest - 2. Fund a quest - 3. Play a quest + +### Additional Resources + +- [Kanban board](https://app.zenhub.com/workspaces/quests-6092dda4c272a5000e858266/board) +- Discord : 1Hive (Quest Swarm channel) +- [Deployed app](https://quests-d1u7l8p9l-1hive.vercel.app/)