From 3c3bfbade38a32ff40da324802a885430260330e Mon Sep 17 00:00:00 2001
From: Sudarsan Balaji <hello@artful.dev>
Date: Tue, 10 Sep 2024 09:47:48 +0100
Subject: [PATCH] Add bugs

---
 bugs/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 bugs/README.md

diff --git a/bugs/README.md b/bugs/README.md
new file mode 100644
index 0000000..8263689
--- /dev/null
+++ b/bugs/README.md
@@ -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`.