@@ -13,23 +13,23 @@ This project provides a simple, performant and resource-efficient key-value stor
1313* Low resource usage (typical memory usage ~ 35MB, negligible CPU usage)
1414* Simple GET/PUT/DELETE operations
1515
16- ## Getting Started
16+ ## Getting started
1717
1818### Running with Docker
1919
2020Run the container with default settings:
2121
2222```
23- docker run -p 8080:8080 ghcr.io/ binaryfire/kv:latest
23+ docker run --name kv - p 8080:8080 binaryfire/kv:latest
2424```
2525
2626For data persistence, map the database directory to a volume:
2727
2828```
29- docker run -p 8080:8080 -v kv-database:/var/www/database ghcr.io/ binaryfire/kv:latest
29+ docker run --name kv - p 8080:8080 -v kv-database:/var/www/database binaryfire/kv:latest
3030```
3131
32- ## API Routes
32+ ## API routes
3333
3434| Method | Route | Description |
3535| --- | --- | --- |
@@ -38,7 +38,13 @@ docker run -p 8080:8080 -v kv-database:/var/www/database ghcr.io/binaryfire/kv:l
3838| PUT | /{key} | Set value for key |
3939| DELETE | /{key} | Delete key |
4040
41- ## Usage Examples
41+ ## API format
42+
43+ The API uses plain text instead of JSON for both requests and responses, making it easier to in scripts and with command-line tools.
44+
45+ When retrieving a value, the raw value is returned without any formatting. When listing all keys, each key is returned on a new line.
46+
47+ ## Usage examples
4248
4349List all keys:
4450
@@ -64,15 +70,15 @@ Delete a key:
6470curl -X DELETE http://localhost:8080/my_key
6571```
6672
67- ## Key Format Requirements
73+ ## Key format requirements
6874
6975All keys must be in lowercase \` snake\_ case\` format:
7076
7177* Must contain only lowercase letters and numbers
7278* Words separated by underscores
7379* Example: ` user_settings ` , ` api_key_1 `
7480
75- ## Building from Source
81+ ## Building locally from source
7682
7783```
7884./build.sh
0 commit comments