From 6150e5dda632369aa589a227e12bf1c0f1b10e07 Mon Sep 17 00:00:00 2001 From: Eric-Paul Ickhorn Date: Thu, 23 May 2024 01:23:49 +0200 Subject: [PATCH] documentation(readme): Extended README.md to include more information. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c1c430..897fb13 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # libUFN -LibUFN is a library of micro-functionalities (µFN). \ No newline at end of file +LibUFN is a library of micro-functionalities (The name stands for µFN). +It currently consists of 2 independent single-header libraries + +## Functionality + +There are only 2 libraries currently: +1) ufn_arena: An arena allocator for optimization of string processing. +2) ufn_round: Functions for rounding to the next multiple of some number + or to the next power of 2. Currently only floor()'s and ceil()'s to those.