Skip to content

Commit

Permalink
Add bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
artfuldev committed Sep 10, 2024
1 parent fb57a39 commit 3c3bfba
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions bugs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# bugs

A CLI written in bun that helps write higher quality tests. A
bun-ny tool to catch bugs, hence the name (Bugs Bunny, anyone?).

## Getting Started

### Installation

You should be able to install `bugs` using `npm`, or related
package managers.

```sh
npm install -g bugs
```

### Usage

We can use bugs in 2 ways:

#### To collect suggestions for tests based on code

```sh
bugs suggest -c code
```

#### To review existing tests for a piece of code

```sh
bugs review -c code - tests
```

### Building

To build `bugs`, we use `bun` with `typescript` on `node 22`.

0 comments on commit 3c3bfba

Please sign in to comment.