adrien/ZipponDB
1
0
Fork 0
Code Actions Releases Activity

Small update on index and README

Browse Source
This commit is contained in:
Adrien Bouvais 2025-01-25 19:13:04 +01:00
parent 78e8b67b80
commit 4066803ecd
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,21 +1,25 @@
![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.png)
ZipponDB is a database written entirely in Zig from scratch with 0 dependencies.
ZipponDB's goal is to be ACID, light, simple, and high-performance. It aims at small to medium applications that don't need fancy features but a simple and reliable database.
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:
* **Small:** Binary is small, around 2-3Mb.
* **Small Binary:** ~300kb.
* **Fast:** Parse millions of entities in milliseconds.
* **Relationship:** Build with focus on easy relationship.
* **Query Language:** Use it's own simple query language.
* **No dependencies:** Depend on nothing, every line of code running is in the codebase.
* **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.
* **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/
<small>* Plan for more platforms like arm, 32 bit system.</small>
<small>** Plan for optimizations.</small>
***Note: ZipponDB is still in Alpha v0.2, see roadmap.***
# Declare a schema

6
docs/index.md
View File

@ -1,4 +1,4 @@
# ZipponDB: A Lightweight Relational Database in Zig
# ZipponDB: A Lightweight Database in Zig
<style>
.md-content .md-typeset h1 { display: none; }
@ -8,7 +8,7 @@
<a href="/ZipponDB"><img src="images/banner.png" alt="ZipponDB"></a>
</p>
<p align="center">
<em>Relational Database written in Zig</em>
<em>Minimalist Database written in Zig</em>
</p>
---
@ -37,7 +37,7 @@ medium applications that want a quick and simple database.
<small>* Plan for more platforms like arm, 32 bit system.</small>
<small>** Plan for optimizations.</small>
### After
### Planned
* **Interface:** Small package to interact with ZipponDB from different programming language.
* **Single file:** Like SQLite, ZipponDB's database aim to be a single file.