Add README

README.md

@@ -1,3 +1,29 @@
-# proposal-23-restore-rewards
+# Proposal 25: restore old rewards
 
-Proposal to restore old rewards value (as before hack) after redeploying Staking contract
+Proposal to restore old rewards value (as before hack) after redeploying Staking contract to stakers, who did not have time to withdraw their rewards due to a bug
+
+### Changes:
+
+- Redeploying staking implementation contract to add new function `setReward`
+- Restore rewards to 357 stakers (all stakers, who had more than 1 TORN in rewards at the time of the hack and didn't have time to withdraw them)
+- Transfer 42 754 TORN from Governance to new Staking contract (so that stakers can withdraw their restored rewards)
+
+### 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))
+
+### Installation
+
+```text
+git clone --recurse-submodules https://git.tornado.ws/Theo/proposal-25-restore-rewards
+cd proposal-25-restore-rewards
+npm install
+```
+
+### Testing
+
+```text
+npm run test
+```