Skip to content

Commit

Permalink
some readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
baxiry committed Jul 10, 2024
1 parent ac9a381 commit 289204d
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
#### ZaraDB



**ZaraDB** is a lightweight fast open-licensed document database with no hidden restrictions.
is a lightweight fast open-licensed document database with no hidden restrictions.
Its goal is to be a lightweight alternative to common documentary databases.
It can also provide superior performance compared to Mongo in many common use cases.

**Limitations**:
Horizontal scale is not one of Zara's goals currently.


**Installation**
download zara pre-compiled from [here](https://github.com/baxiry/zaradb/releases), extract it, and run it as any program.

Expand All @@ -20,6 +15,17 @@ git clone --depth 1 https://github.com/baxiry/zaradb.git && cd zaradb && go buil

and then open : `localhost:1111`


**Documentations**
#### Documentations:
this docs is for libs dev, but it good for everyone :
[zara api](https://github.com/baxiry/zaradb/wiki/Zara-API)

> [!WARNING]
> It is possible that some things will change within the API,
> The changes will be partial. Then it stabilizes completely in version 1.0.0
> This documentation is intended for library developers, but is useful to anyone interested in documentary databases
#### Limitations:
> [!WARNING]
> Horizontal scale is not one of Zara's goals currently.

0 comments on commit 289204d

Please sign in to comment.