Skip to content

Commit 23cda64

Browse files
committed
update docs (#76)
1 parent 9261344 commit 23cda64

File tree

7 files changed

+24
-5
lines changed

7 files changed

+24
-5
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ with TCP sockets and a [RESP](https://redis.io/topics/protocol) protocol.
1212
![Lines of code](https://img.shields.io/tokei/lines/github/keva-dev/keva?style=flat-square)
1313
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/keva-dev/keva?style=flat-square)
1414
![GitHub](https://img.shields.io/github/license/keva-dev/keva?style=flat-square)
15+
![Maven Central](https://img.shields.io/maven-central/v/dev.keva/kevadb?style=flat-square)
1516

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

docs/src/guide/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ with TCP sockets and a [RESP](https://redis.io/topics/protocol) protocol.
88

99
## Features
1010

11-
- High performance and low latency in-memory key-value database
11+
- Low latency in-memory key-value database
1212
- Compatible with Redis protocol
1313
- Multithreading engine helps to maximize the use of system's resources
1414
- Persistence in-memory data to disk

docs/src/guide/insight/benchmark.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Benchmark
22

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

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

99
Redis 6.2.6:
1010

docs/src/guide/overview/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Parameters:
3434

3535
## Docker
3636

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

3939
Pull image:
4040

docs/src/guide/overview/replication.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
:::warning WIP
44
This feature is under development
55
:::
6+
7+
This feature is not available yet.

docs/src/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ features:
1010
- title: High Throughput
1111
details: Keva comes with multithreaded engine which will maximize the use of your system's resources
1212
- title: High Availability
13-
details: Simplify your high availability setup with master-replica nodes, sharded cluster mode will also be available soon
13+
details: Simplify your high availability setup with master-replica nodes and sharded cluster mode (will be available soon)
1414
footer: Apache-2.0 Licensed | Copyright © 2021 Keva Team
1515
---
1616

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

2324
<div style="margin-top: 2rem; max-width: 960px; text-align: center; font-size: 1.5rem; font-weight: bold;">Lab Product of</div>

docs/src/team/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,19 @@ Keva project is built by a team of enthusiastic and passionate engineers formed
6767
</p>
6868
</td>
6969
</tr>
70+
<tr style="background: #fff">
71+
<td><img src="https://avatars.githubusercontent.com/u/18006732?v=4" style="max-width: 100px;"></td>
72+
<td>
73+
<h3>An Nguyen</h3>
74+
<p>Core Focus</p>
75+
<p>
76+
<img src="https://image.flaticon.com/icons/png/512/25/25231.png" style="max-width: 12.5px; margin-right: 2.5px;"/>
77+
<a href="https://github.com/yampml" target="_blank">yampml</a>
78+
</p>
79+
<p>
80+
<img src="https://i.imgur.com/dKTwo4A.jpg" style="max-width: 12.5px; margin-right: 2.5px;"/>
81+
<a href="mailto:[email protected]" target="_blank">[email protected]</a>
82+
</p>
83+
</td>
84+
</tr>
7085
</table>

0 commit comments

Comments
 (0)