From 6e3367c81f787959ae1fa01965a54ac667412453 Mon Sep 17 00:00:00 2001
From: blek <me@blek.codes>
Date: Fri, 3 Nov 2023 02:16:17 +1000
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..574ab23
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# blek! File CLI
+This is the CLI for [blek! File](https://git.blek.codes/blek/bfile).
+
+It is written in Go since I thought that it would be fun to try out this cool shiny language, which I regret dearly and can't imagine the pain maintaining this.
+
+Also this app utilizes the bFile's [cURL API](https://git.blek.codes/blek/bfile/pulls/15)
+
+## Building
+```sh
+$ git clone this://repo
+$ cd repo
+$ go build .
+$ ./bfile_cli
+```
+
+## Debugging
+Same as the build, I guess. I am not really a go programmer, but I suppose that if you want to debug this, you already know the go way to debug a CLI app and this section is useless for you.
+
+## Usage
+```sh
+$ bfile_cli upload file.txt https://instance.url.com
+```