From 9097657d8ed9b67ac8f5d11c3fad4edddca90dc4 Mon Sep 17 00:00:00 2001
From: Jonas Bostoen <jonas.bostoen@hotmail.com>
Date: Fri, 5 May 2023 14:56:50 +0200
Subject: [PATCH] doc: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9cc6b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# `cbctl`
+
+`cbctl` is a CLI tool for interacting with the Chainbound backend.
+
+## Installation
+With Go:
+```bash
+go get github.com/chainbound/cbctl
+```
+
+## Usage
+First, initialize `cbctl` with your API key. This will write a config file to `~/.config/cbctl/config.toml`:
+```bash
+cbctl init --key <your_api_key>
+```
+
+### Fiber Commands
+The `fiber` subcommand let's you interact with the Fiber backend.
+
+* `cbctl fiber quota`
+Gets your quota for the current billing period.
+* `cbctl fiber trace tx --hash <tx_hash>`
+Gets the trace for a transaction. Run `cbctl fiber trace tx --help` for more info.