Skip to content

Commit 34d7675

Browse files
committed
Add libcni README that explains how it relates to the spec.
Nothing dramatic, but just to have a thing Signed-off-by: Benjamin Leggett <[email protected]>
1 parent 0137b32 commit 34d7675

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Diff for: libcni/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# libcni
2+
3+
`libcni` is a library that parses and loads CNI configurations as defined in the [CNI spec](../SPEC.md).
4+
5+
It is designed to be used by runtimes for this purpose, and is kept in sync with the CNI spec as a reference library implementation so that runtimes do not have to build and maintain their own implementations of the CNI spec, or construct their own parsing and loading logic.
6+
7+
It is not required to use this library to be compliant with the [CNI spec](../SPEC.md).
8+
9+
While the [CNI spec](../SPEC.md) only dictates the API and types, and does not dictate operational concerns or how or where from configuration is loaded, `libcni` is an opinionated, file-based implementation, and primarily loads and validates CNI spec-compliant configuration files from disk.

0 commit comments

Comments
 (0)