Skip to content

Commit

Permalink
update docs (#76)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhuynh27 committed Dec 16, 2021
1 parent 9261344 commit 23cda64
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 5 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ with TCP sockets and a [RESP](https://redis.io/topics/protocol) protocol.
![Lines of code](https://img.shields.io/tokei/lines/github/keva-dev/keva?style=flat-square)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/keva-dev/keva?style=flat-square)
![GitHub](https://img.shields.io/github/license/keva-dev/keva?style=flat-square)
![Maven Central](https://img.shields.io/maven-central/v/dev.keva/kevadb?style=flat-square)

Major dependencies: [Netty](https://github.com/netty/netty), [ChronicleMap](https://github.com/OpenHFT/Chronicle-Map)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with TCP sockets and a [RESP](https://redis.io/topics/protocol) protocol.

## Features

- High performance and low latency in-memory key-value database
- Low latency in-memory key-value database
- Compatible with Redis protocol
- Multithreading engine helps to maximize the use of system's resources
- Persistence in-memory data to disk
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guide/insight/benchmark.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Benchmark

:::warning WIP
Because we're in early development stage, a more detailed test will be provided later (when Keva is more mature and stable)
Because we're in early development stage, a more detailed benchmark will be provided later (when Keva is more mature and stable)
:::

Keva's performance is on par with the Redis 6.2.6
Keva's throughput and latency (`GET`/`SET`) is on par with the Redis 6.2.6

Redis 6.2.6:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/guide/overview/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters:

## Docker

Available in [Docker Hub](https://hub.docker.com/r/kevadev/keva-server)
Available at [Docker Hub](https://hub.docker.com/r/kevadev/keva-server)

Pull image:

Expand Down
2 changes: 2 additions & 0 deletions docs/src/guide/overview/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
:::warning WIP
This feature is under development
:::

This feature is not available yet.
3 changes: 2 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ features:
- title: High Throughput
details: Keva comes with multithreaded engine which will maximize the use of your system's resources
- title: High Availability
details: Simplify your high availability setup with master-replica nodes, sharded cluster mode will also be available soon
details: Simplify your high availability setup with master-replica nodes and sharded cluster mode (will be available soon)
footer: Apache-2.0 Licensed | Copyright © 2021 Keva Team
---

<p style="text-align: right; max-width: 960px; margin: auto;">
<img src="https://img.shields.io/github/workflow/status/keva-dev/keva/Build/master?label=build&style=flat-square" alt="GitHub Workflow Status (branch)">
<img src="https://img.shields.io/tokei/lines/github/keva-dev/keva?style=flat-square" alt="Lines of code">
<img src="https://img.shields.io/github/license/keva-dev/keva?style=flat-square" alt="GitHub">
<img src="https://img.shields.io/maven-central/v/dev.keva/kevadb?style=flat-square" alt="Maven Central">
</p>

<div style="margin-top: 2rem; max-width: 960px; text-align: center; font-size: 1.5rem; font-weight: bold;">Lab Product of</div>
Expand Down
15 changes: 15 additions & 0 deletions docs/src/team/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,19 @@ Keva project is built by a team of enthusiastic and passionate engineers formed
</p>
</td>
</tr>
<tr style="background: #fff">
<td><img src="https://avatars.githubusercontent.com/u/18006732?v=4" style="max-width: 100px;"></td>
<td>
<h3>An Nguyen</h3>
<p>Core Focus</p>
<p>
<img src="https://image.flaticon.com/icons/png/512/25/25231.png" style="max-width: 12.5px; margin-right: 2.5px;"/>
<a href="https://github.com/yampml" target="_blank">yampml</a>
</p>
<p>
<img src="https://i.imgur.com/dKTwo4A.jpg" style="max-width: 12.5px; margin-right: 2.5px;"/>
<a href="mailto:[email protected]" target="_blank">[email protected]</a>
</p>
</td>
</tr>
</table>

0 comments on commit 23cda64

Please sign in to comment.