Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vstakhov authored Feb 1, 2024
1 parent 803b588 commit 954ec92
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# LIBUCL
# UCL - Universal Configuration Language

**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)*

Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 954ec92

Please sign in to comment.