docs(readme): add banner and quick-start badges
All checks were successful
Build / cmake-build (push) Successful in 34s
Build / build-script (push) Successful in 8s
Build / unit-tests (push) Successful in 27s

This commit is contained in:
2026-06-19 19:12:20 -05:00
parent d0b02f4735
commit 2c0aae0406
2 changed files with 22 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 808 KiB

View File

@@ -1,9 +1,30 @@
# iKv ![iKv banner](.gitea/images/iKv_banner.png)
[![Build](https://dock-it.dev/iDENTITY-Technology/iKv/actions/workflows/build.yml/badge.svg?branch=main)](https://dock-it.dev/iDENTITY-Technology/iKv/actions?workflow=build.yml)
[![Latest release](https://img.shields.io/gitea/v/release/iDENTITY-Technology/iKv?gitea_url=https%3A%2F%2Fdock-it.dev&label=release)](https://dock-it.dev/iDENTITY-Technology/iKv/releases/latest)
[![Language](https://img.shields.io/badge/C-C99-00599C?logo=c)](https://en.cppreference.com/w/c/language)
[![License](https://img.shields.io/badge/license-CC_BY--SA_4.0-lightgrey.svg)](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