Add README

This commit is contained in:
Nathan Fisher 2024-06-03 23:43:44 -04:00
parent b4444d04c3
commit 08134db66b

10
README.md Normal file
View File

@ -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.