From 24fccc648776ebc876ce22bfa94f14855f6fb60e Mon Sep 17 00:00:00 2001 From: MrBounty Date: Sat, 4 Jan 2025 18:37:20 +0100 Subject: [PATCH] Update readme --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 082da03..792646a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,32 @@ -![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.png) +

+ ZipponDB +

+

+ Minimalist Lightweight General Purpose Database written in Zig +

+ +--- + +**Documentation**: https://mrbounty.github.io/ZipponDB + +**Source Code**: https://github.com/MrBounty/ZipponDB + +--- ZipponDB is a database built from the ground up in Zig, with zero external dependencies. Designed for simplicity, performance, and portability, it's almost usable for small to medium applications that want a quick and simple database. -Key Features: +## Key Features * **Small Binary:** ~300kb. -* **Fast:** Parse millions of entities in milliseconds. +* **Fast:** Parse millions of entities in milliseconds.* * **Relationship:** Build with focus on easy relationship. -* **Query Language:** Use it's own simple query language. +* **Query Language:** Use it's own stupid query language. * **No dependencies:** Depend on nothing, every line of code running is in the codebase and written for ZipponDB. * **Open-source:** Open-source under MIT licence. -* **Portable:** Easily compiled and deployed across various platforms.* -* **Low memory and safe:** Low memory footprint. (~8Mb / 100k entities)**. -For more informations visit the docs: https://mrbounty.github.io/ZipponDB/ - -* Plan for more platforms like arm, 32 bit system. -** Plan for optimizations. - -***Note: ZipponDB is still in Alpha v0.2, see roadmap.*** +* Check benchmark. # Declare a schema