From bc71c87aa07cd0b56cbc46c148fdd6b6ea4832e5 Mon Sep 17 00:00:00 2001
From: Daniel Tomlinson <dtomlinson@panaetius.co.uk>
Date: Fri, 6 May 2022 02:37:08 +0100
Subject: [PATCH] add `README.md`

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0e77f22..836ad82 100644
--- 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.