Skip to content

Commit

Permalink
Update to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lamba92 committed Dec 14, 2024
1 parent 1c1682b commit f47d75e
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ google/leveldb is licensed under [BSD-3-Clause license](https://github.com/googl
# Index

1. [Introduction](#leveldb-for-kotlin-multiplatform)
- [Overview](#leveldb-for-kotlin-multiplatform)
- [Supported Platforms](#supported-platforms)
- [Overview](#leveldb-for-kotlin-multiplatform)
- [Supported Platforms](#supported-platforms)
2. [Usage](#usage)
- [Dependency Setup](#dependency-setup)
- [Code Example](#in-your-code)
- [Snapshots](#snapshots-of-latest-commits)
- [Dependency Setup](#dependency-setup)
- [Code Example](#in-your-code)
- [Snapshots](#snapshots-of-latest-commits)
3. [Benchmarks](#benchmarks)
- [Ubuntu x64 Benchmarks](#ubuntu-x64)
- [Windows x64 Benchmarks](#windows-x64)
- [macOS arm64 Benchmarks](#macos-arm64)
- [Ubuntu x64 Benchmarks](#ubuntu-x64)
- [Windows x64 Benchmarks](#windows-x64)
- [macOS arm64 Benchmarks](#macos-arm64)


## Supported Platforms
Expand All @@ -45,6 +45,7 @@ LevelDB binaries are built in [lamba92/leveldb-builds](http://github.com/lamba92

## Usage

### Dependency Setup
**See [releases](https://github.com/lamba92/kotlin-leveldb/releases) for the latest version!**

In your `build.gradle.kts` file:
Expand All @@ -66,8 +67,8 @@ dependencies {
implementation("com.github.lamba92:kotlin-leveldb:{latest-version}")
}
```
### In your code

In your code:
```kotlin
val db = LevelDB("/path/to/db/as/string")

Expand All @@ -77,6 +78,7 @@ db.delete("key")
db.close()
```

### Snapshots of latest commits
Snapshots of latest commits are available in
[Sonatype's snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/).
Can be used by adding the repository and the dependency:
Expand All @@ -102,7 +104,7 @@ Benchmarks uses Kotlin/Native only, so the JVM version is not tested.

As of December 2024:

**Ubuntu x64**
### Ubuntu x64

| Operation | Ops/sec (avg over 10 runs) |
|----------------------------|----------------------------|
Expand All @@ -112,7 +114,7 @@ As of December 2024:
| Burst Single Delete | 287.94k |
| Batch Put | 1116.69k |

**Windows x64**
### Windows x64

| Operation | Ops/sec (avg over 10 runs) |
|----------------------------|----------------------------|
Expand All @@ -125,7 +127,7 @@ As of December 2024:
| Batch Delete | 1266.11k |


**macOS arm64**
### macOS arm64

| Operation | Ops/sec (avg over 10 runs) |
|----------------------------|----------------------------|
Expand Down

0 comments on commit f47d75e

Please sign in to comment.