Skip to content

Commit bd9c2ae

Browse files
BowTiedRadonemoodmosaic
authored andcommitted
Update README installation and usage instructions
1 parent 13b05ac commit bd9c2ae

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,41 @@ root
2626
└── Devnet.toml
2727
```
2828

29-
### Usage
29+
### Installation
3030

31-
Run the fuzzer with the following command:
31+
---
32+
33+
**Install the package locally**
34+
35+
```
36+
npm install "https://github.com/stacks-network/rendezvous.git"
37+
```
38+
39+
Run the fuzzer locally:
40+
41+
```
42+
npx rv <path-to-clarinet-project> <contract-name> <type>
43+
```
44+
45+
---
46+
47+
**Install the package globally**
48+
49+
```
50+
git clone https://github.com/stacks-network/rendezvous
51+
npm install
52+
npm install --global .
53+
```
54+
55+
Run the fuzzer from anywhere on your system:
3256

3357
```
3458
rv <path-to-clarinet-project> <contract-name> <type>
3559
```
3660

37-
This will execute the fuzzing process, attempting to falsify invariants or tests.
61+
---
62+
63+
### Configuration
3864

3965
**Positional arguments:**
4066

0 commit comments

Comments
 (0)