From 08134db66b1d846052742c6004adc9b320f07df1 Mon Sep 17 00:00:00 2001
From: Nathan Fisher <jeang3nie@hitchhiker-linux.org>
Date: Mon, 3 Jun 2024 23:43:44 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad2779a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Summary
+This is a base64 encoder/decoder in zig. The default alphabet is the rfc4648 base64
+specification, but custom alphabets may be used. The library is designed to highly
+efficient and very fast. Assumong a supported platform encoding and decoding
+operations will take advantage of SIMD (Single Instruction Multiple Data) processor
+intrinsics to work on multiple bytes of data in parallel, while only using a single
+processor.
+
+## Supported Zig version
+Currently this library is designed and tested with Zig version 0.12.0.