docs(readme): add banner and quick-start badges
This commit is contained in:
BIN
.gitea/images/iKv_banner.png
Normal file
BIN
.gitea/images/iKv_banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 808 KiB |
23
README.md
23
README.md
@@ -1,9 +1,30 @@
|
|||||||
# iKv
|

|
||||||
|
|
||||||
|
[](https://dock-it.dev/iDENTITY-Technology/iKv/actions?workflow=build.yml)
|
||||||
|
[](https://dock-it.dev/iDENTITY-Technology/iKv/releases/latest)
|
||||||
|
[](https://en.cppreference.com/w/c/language)
|
||||||
|
[](https://dock-it.dev/iDENTITY-Technology/iKv/src/branch/main/LICENSE)
|
||||||
|
|
||||||
iKv is a small standalone C library for reading, writing, and building iKv data trees.
|
iKv is a small standalone C library for reading, writing, and building iKv data trees.
|
||||||
It supports both text and binary formats, keeps the public API in a single header, and
|
It supports both text and binary formats, keeps the public API in a single header, and
|
||||||
handles multiple on-disk versions behind one interface.
|
handles multiple on-disk versions behind one interface.
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
Build with CMake:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cmake -S . -B build
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
Link it from another CMake project:
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
add_subdirectory(path/to/iKv)
|
||||||
|
target_link_libraries(your_target PRIVATE ikv::ikv)
|
||||||
|
```
|
||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
- Parse iKv text from strings or files
|
- Parse iKv text from strings or files
|
||||||
|
|||||||
Reference in New Issue
Block a user