diff --git a/README.md b/README.md index 4cfdd04..0c9881c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # potential-robot +Big Thanks to Done Collectively, Stellar, Helios, Gimbalabs and James D., Romain Soulat IOG. -Thank's to Randall Harmon, Helios community, Gimbalabs and James D., Romain Soulat IOG. +## Usage +1. `npm install` +2. `npm test` + +## How does it work? +Start by cloning the repo and experimenting with the network emulator. + +Experiment with transaction inputs, find conditions that cause "transaction rejected" error. + +Experiment with the validator logic, e.g. https://github.com/aleeusgr/sniffle -This is a toolbox for test-driven development on Cardano, using Helios. -Start cloning the repo and experimenting with the ledger emulator. -Gather product requirements and user stories, create Issues, formulate testable expectations and make tests pass. -Contribute +To build your dApp gather product requirements and user stories, create Issues - formulate testable expectations and make tests pass. ## Documentation: [Vitest](https://vitest.dev/) @@ -13,12 +20,3 @@ Contribute [Helios](https://github.com/Hyperion-BT/helios) [Helios vesting example](https://github.com/lley154/helios-examples/tree/main/vesting) - -## Usage -1. `npm install` -2. `npm test` -3. onchain code is in `./src/vesting.hl` -4. `./tests/unit` document Helios API -5. tests in `./tests/*.test.ts` use pre-defined environment to run a transaction as a test and as an importable module. -6. importable transaction modules are in `src` -