diff --git a/.gitea/images/iKv_banner.png b/.gitea/images/iKv_banner.png new file mode 100644 index 0000000..2cec979 Binary files /dev/null and b/.gitea/images/iKv_banner.png differ diff --git a/README.md b/README.md index b075178..6154d37 100644 --- a/README.md +++ b/README.md @@ -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. It supports both text and binary formats, keeps the public API in a single header, and 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 - Parse iKv text from strings or files