From 954ec92b35b7346a33d655e8c238b667bdb41744 Mon Sep 17 00:00:00 2001 From: Vsevolod Stakhov Date: Thu, 1 Feb 2024 11:35:51 +0000 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 94acfec..321db17 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# LIBUCL +# UCL - Universal Configuration Language **Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)* @@ -22,15 +22,19 @@ ## Introduction -This document describes the main features and principles of the configuration -language called `UCL` - universal configuration language. +This repository provides the `C` library for parsing configurations written in `UCL` - universal configuration language. It also provides functions to operate with other formats: + +* `JSON`: read, write and pretty format +* `Messagepack`: read and write +* `S-Expressions`: read only (canonical form) +* `Yaml`: limited write support (mainly for compatibility) If you are looking for the libucl API documentation you can find it at [this page](doc/api.md). ## Basic structure -UCL is heavily infused by `nginx` configuration as the example of a convenient configuration -system. However, UCL is fully compatible with `JSON` format and is able to parse json files. +`UCL` is heavily infused by `nginx` configuration as the example of a convenient configuration +system. However, `UCL` is fully compatible with `JSON` format and is able to parse json files. For example, you can write the same configuration in the following ways: * in nginx like: @@ -230,7 +234,7 @@ UCL supports external macros both multiline and single line ones: ``` Moreover, each macro can accept an optional list of arguments in braces. These -arguments themselves are the UCL object that is parsed and passed to a macro as +arguments themselves are the `UCL` object that is parsed and passed to a macro as options: ```nginx