Skip to content

Commit

Permalink
Update README installation and usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
BowTiedRadone authored and moodmosaic committed Jan 3, 2025
1 parent 13b05ac commit bd9c2ae
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,41 @@ root
└── Devnet.toml
```

### Usage
### Installation

Run the fuzzer with the following command:
---

**Install the package locally**

```
npm install "https://github.com/stacks-network/rendezvous.git"
```

Run the fuzzer locally:

```
npx rv <path-to-clarinet-project> <contract-name> <type>
```

---

**Install the package globally**

```
git clone https://github.com/stacks-network/rendezvous
npm install
npm install --global .
```

Run the fuzzer from anywhere on your system:

```
rv <path-to-clarinet-project> <contract-name> <type>
```

This will execute the fuzzing process, attempting to falsify invariants or tests.
---

### Configuration

**Positional arguments:**

Expand Down

0 comments on commit bd9c2ae

Please sign in to comment.