From bb662e377c03d6d2899079d6171281c16b4f27d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Wed, 22 Mar 2023 18:14:12 +0700 Subject: [PATCH] Update README * Add build status badge * Add section about testing * Formatting --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index da0000a..7a71c6a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![npm](https://img.shields.io/npm/v/@kredits/contracts.svg)](https://www.npmjs.com/package/@kredits/contracts) +[![Build Status](https://drone.kosmos.org/api/badges/kredits/contracts/status.svg)](https://drone.kosmos.org/kredits/contracts) # Kredits Contracts @@ -26,27 +27,27 @@ To run a local development chain run: ### Bootstrap -1. Run an EVM node and ipfs +1. Run an EVM node and ipfs $ npm run devchain $ ipfs daemon -2. Compile contracts and build ABIs +2. Compile contracts and build ABIs (compiled artifacts will be in `/artifacts`) $ npm run build -3. Deploy new upgradable contract proxies +3. Deploy new upgradable contract proxies $ npm run deploy:dao -4. Execute seeds to create demo contributors, contributions, etc. (optional) +4. Execute seeds to create demo contributors, contributions, etc. (optional) $ npm run seeds **Step 2-4 is also summarized in `npm run bootstrap`** -5. Show contract addresses +5. Show contract addresses $ cat lib/addresses.json @@ -56,6 +57,16 @@ If you need to fund development accounts with devchain coins: $ npm run fund # or hardhat fund --network localhost +## Specs / Testing + +With a local development chain running: + + $ hardhat test + +If you add or change contract code, please make sure to add and/or adapt tests +accordingly. Don't worry, it's easy! You can use existing tests as a template +for new ones. + ## Contract architecture We use the [OpenZeppelin hardhat