From 84882d29915dbcfda42eee53839d6785293ef82c Mon Sep 17 00:00:00 2001
From: Yves Biener <yves.biener@gmx.de>
Date: Sat, 9 Nov 2024 21:47:52 +0100
Subject: [PATCH] doc: initial readme documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83e9ad9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# zterm Terminal User Interface Library
+
+`zterm` is a terminal user interface library to implement terminal (fullscreen or inline) applications.
+
+> [!NOTE]  
+> Currently `zig 0.13.0` is officially supported. Builds using the master version might not work.
+
+## Usage
+
+To include `zterm` as a dependency in your project run the following command:
+
+```sh
+zig fetch --save git+https://gitea.yves-biener.de/yves-biener/zterm
+```