add README.md

2022-05-06 02:37:08 +01:00
parent 2f6f0100a0
commit bc71c87aa0
1 changed files with 17 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
-unraid-bat
+# bat
+
+This is the repository for the exa bat plugin.
+
+<img src="https://git.panaetius.co.uk/dtomlinson91/unraid-bat/raw/branch/master/assets/unraid-bat.svg"/>
+
+## description
+
+A cat(1) clone with syntax highlighting and Git integration.
+
+See the [git repository](https://github.com/sharkdp/bat) for bat for more information.
+
+## dev
+
+Drone builds the plugin source using cargo on a new tag creation.
+
+Tag versions follow bat releases.