fix quick start instructions
This commit is contained in:
18
README.md
18
README.md
@@ -29,7 +29,21 @@ It speaks the DynamoDB wire protocol, so any existing AWS SDK client works again
|
||||
- ✅ **Persistent Storage**: RocksDB-backed with full ACID guarantees
|
||||
- ✅ **Concurrency**: Table-level RW locks for safe concurrent access
|
||||
|
||||
## Quick Start
|
||||
## Quick Start - Easy
|
||||
|
||||
## Option A
|
||||
```
|
||||
# The compose file pulls from a container registry
|
||||
docker compose up
|
||||
```
|
||||
|
||||
## Option B
|
||||
```
|
||||
# Builds the local files in a container and then runs the container
|
||||
docker run -it --rm $(docker build -q .)
|
||||
```
|
||||
|
||||
## Quick Start - Local
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -47,7 +61,7 @@ brew install rocksdb odin
|
||||
|
||||
```bash
|
||||
sudo apt install librocksdb-dev libsnappy-dev liblz4-dev libzstd-dev libbz2-dev
|
||||
# Install Odin from https://odin-lang.org/docs/install/
|
||||
# Just snag this (https://github.com/odin-lang/Odin/releases/download/dev-2026-02/odin-linux-amd64-dev-2026-02.tar.gz) and symlink the odin binary in the folder to your /bin
|
||||
```
|
||||
|
||||
### Build & Run
|
||||
|
||||
Reference in New Issue
Block a user