add README.md

This commit is contained in:
blek 2023-11-03 02:16:17 +10:00
parent 87b3cbca26
commit 6e3367c81f
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 22 additions and 0 deletions

22
README.md Normal file
View File

@ -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
```