diff --git a/README.md b/README.md index 9265b45..f6a1d87 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,13 @@ -## Foundry +## Decentralized Lottery with Chainlink VRF 🎲 -**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** +A fully decentralized lottery application built in Solidity, utilizing Chainlink VRF for provably fair randomization. This project includes comprehensive test coverage with Foundry, ensuring security and reliability. -Foundry consists of: +Features -- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools). -- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. -- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network. -- **Chisel**: Fast, utilitarian, and verbose solidity REPL. +Smart Contracts: Core logic written in Solidity +Chainlink VRF: Secures random number generation for lottery fairness +Automations: Scheduled lottery draws and automated prize distribution +Testing: Full coverage of contract tests in Foundry for robust verification +Perfect for learning decentralized apps, smart contract testing, and the Chainlink VRF. -## Documentation - -https://book.getfoundry.sh/ - -## Usage - -### Build - -```shell -$ forge build -``` - -### Test - -```shell -$ forge test -``` - -### Format - -```shell -$ forge fmt -``` - -### Gas Snapshots - -```shell -$ forge snapshot -``` - -### Anvil - -```shell -$ anvil -``` - -### Deploy - -```shell -$ forge script script/Counter.s.sol:CounterScript --rpc-url --private-key -``` - -### Cast - -```shell -$ cast -``` - -### Help - -```shell -$ forge --help -$ anvil --help -$ cast --help -``` +This version highlights each major component with a clear focus on functionality and testing!