aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Pasquet <dev@etenil.net>2021-11-16 22:46:16 +0000
committerGuillaume Pasquet <dev@etenil.net>2021-11-16 22:46:16 +0000
commitc2275229d52b553420b1de50a56919f2063d3e12 (patch)
tree0b74a5ac0ffb0dbbac2e0b4d4bb47576d5bc00db
parent969100547b20b03fd7114141db2dfd21345d4bd9 (diff)
Improved readme
-rw-r--r--README.md21
-rw-r--r--doc/logo.pngbin0 -> 9255 bytes
2 files changed, 19 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8bee0b6..b6b7b58 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
-# barb
+BARB
+====
+
+[Barb logo](doc/logo.png)
+
+Barb is a file-based API query tool written in Rust that works nicely with version control and fits into unix terminal usage.
+
+## Example usage
+
+(not working yet)
+
+```
+barb <file1> <file2>
+```
+
+## Credits
+
+- Code: [Guillaume Pasquet](https://gitlab.com/guillaume54/)
+- Logo: [Harpoon Chain Icon](https://game-icons.net/1x1/lorc/harpoon-chain.html) by Lorc under CC By 3.0
-Barb is a file-based API query tool written in Rust that works nicely with version control and fits into unix terminal usage. \ No newline at end of file
diff --git a/doc/logo.png b/doc/logo.png
new file mode 100644
index 0000000..bbb343e
--- /dev/null
+++ b/doc/logo.png
Binary files differ