Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomfran committed Oct 21, 2023
1 parent 88e8a64 commit 375c039
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 7 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,26 @@ An implementation of the Log-Structured Merge Tree (LSM tree) data structure in

**Table of Contents**

1. [Sorted String Table](#SSTable)
2. [Skip-List](#Skip-List)
3. [Tree](#Tree)
1. [Architecture](#Architecture)
1. [SSTable](#SSTable)
2. [Skip-List](#Skip-List)
3. [Tree](#Tree)
4. [Benchmarks](#Benchmarks)
1. [SSTable](#sstable-1)
2. [Skip-List](#skip-list-1)
3. [Tree](#tree-1)
5. [Implementation status](#Implementation-status)

## Console

To interact with a toy tree you can use `./gradlew run -q` to spawn a console.

![console.png](misc%2Fconsole.png)

---

# Architecture

## SSTable

Sorted String Table (SSTable) is a collection of files modelling key-value pairs in sorted order by key.
Expand Down
Binary file modified misc/console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions src/main/java/com/tomfran/lsm/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ public static void main(String[] args) {
String help = """
Commands:
- s/set <key> <value> : insert a key-value pair;
- g/get <key> : get a value for a key;
- d/del <key> : delete a key-value pair;
- e/exit : exit the application;
- d/help : show this list.
- g/get <key> : get a key value;
- d/del <key> : delete a key;
- e/exit : stop the console;
- d/help : show this message.
""";

System.out.println(intro);
Expand Down

0 comments on commit 375c039

Please sign in to comment.