Add actual info about proposal in README
This commit is contained in:
parent
633981e687
commit
d3b2d87799
28
README.md
28
README.md
@ -1,22 +1,20 @@
|
||||
# Proposal title
|
||||
# Proposal 39 - Project expenses one year reimbursement
|
||||
|
||||
### Changes / effect description
|
||||
### Description
|
||||
|
||||
- 1
|
||||
- 2
|
||||
- ...
|
||||
- Send reimbursement amount in TORN tokens to developer and immediately convert it in any stablecoin
|
||||
|
||||
### Requirements
|
||||
|
||||
- Rust ([Need only for Windows](https://doc.rust-lang.org/cargo/getting-started/installation.html))
|
||||
- Foundryup ([Windows](https://github.com/altugbakan/foundryup-windows), [Linux](https://book.getfoundry.sh/getting-started/installation))
|
||||
- Node 14 or higher ([Windows](https://github.com/coreybutler/nvm-windows), [Linux](https://github.com/nvm-sh/nvm))
|
||||
- Node 16 or higher ([Windows](https://github.com/coreybutler/nvm-windows), [Linux](https://github.com/nvm-sh/nvm))
|
||||
|
||||
### Installation
|
||||
|
||||
```text
|
||||
git clone --recurse-submodules <proposal-repo-link>
|
||||
cd <proposal-name>
|
||||
git clone --recurse-submodules https://git.tornado.ws/Theo/proposal-39-one-year-reimbursement
|
||||
cd proposal-39-one-year-reimbursement
|
||||
npm install
|
||||
```
|
||||
|
||||
@ -43,3 +41,17 @@ or
|
||||
```text
|
||||
npm run test:gas:linux
|
||||
```
|
||||
|
||||
### Verification
|
||||
|
||||
Amount of tokens is calculated in this [script](scripts/calculateReimbursement.ts) using Binance 7-day average price
|
||||
|
||||
Test yourself:
|
||||
|
||||
```
|
||||
npm run calculateReimbursementAmount
|
||||
```
|
||||
|
||||
### Contract
|
||||
|
||||
Proposal deployed contract code:
|
||||
|
@ -8,7 +8,7 @@
|
||||
"private": false,
|
||||
"scripts": {
|
||||
"init": "cd lib && git clone --recurse-submodules https://github.com/foundry-rs/forge-std",
|
||||
"calculate": "ts-node --esm scripts/calculateReimbursement.ts",
|
||||
"calculateReimbursementAmount": "ts-node --esm scripts/calculateReimbursement.ts",
|
||||
"test:windows": ".\\.env.bat && forge test",
|
||||
"test:linux": ". .env && forge test",
|
||||
"test:gas:windows": ".\\.env.bat && forge test --gas-report",
|
||||
|
Loading…
Reference in New Issue
Block a user