Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aloima committed Sep 12, 2024
1 parent 068ac03 commit f0fa6f8
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# tellydb
A toy database project for educational purposes.
A toy key-value database project for educational purposes.

## Features
+ Partially implemented [RESP2](https://redis.io/docs/latest/develop/reference/protocol-spec/) from redis.
+ Includes B-Tree for caching.
+ Fully configurable via [.tellyconf](./FILE.md).
+ Includes transaction/command queue system.

## Usage
Start the server, install a tool that you can connect to redis server like redis-cli. Start to use!

## Quick Start
To get information about server, use `telly help`.
To get information about available commands, look at [src/commands](./src/commands/)

## License
Licensed under [BSD-3 Clause Clear License](./LICENSE).

0 comments on commit f0fa6f8

Please sign in to comment.