Updates.

README.md

@@ -32,11 +32,50 @@
 
 ## Overview
 
-A key-value pair with the key and value on different lines.
+KIVI format deserializer.
 
-## Project status
+KIVI is a simple text format for storing keys with associated values on separate lines.
+While it is not as widely known as formats like JSON or INI, it is straightforward
+and particularly useful in specific contexts where keys or values consist
+of multiple lines of text.
 
-**WORK IN PROGRESS**
+An example of a configuration file in KIVI format:
+
+```text
+host
+127.0.0.1
+
+port
+54321
+
+timeout
+12ms
+```
+
+`host`, `port` and `timeout` are keys; `127.0.0.1`, `54321`, `12ms` are values.
+
+It is quite similar to properties or INI file that store key-value pair in a single line.
+
+In KIVI format, the key and/or value may span over multiple lines.
+Multiple-line keys or values must be enclosed in quotation marks.
+
+ ```text
+host
+127.0.0.1
+
+port
+54321
+
+timeout
+12ms
+
+"General
+ description"
+"This configuration file
+ should be placed in the same
+ directory where the servers
+ binary is placed"
+```
 
 ## License
 

src/lib.rs

@@ -19,9 +19,11 @@
 //! ```
 //!
 //! `host`, `port` and `timeout` are keys; `127.0.0.1`, `54321`, `12ms` are values.
+//!
 //! It is quite similar to properties or INI file that store key-value pair in a single line.
 //!
-//! In KIVI format, the key and/or value may span over multiple lines:
+//! In KIVI format, the key and/or value may span over multiple lines.
+//! Multiple-line keys or values must be enclosed in quotation marks.
 //!
 //! ```text
 //! host
@@ -40,7 +42,6 @@
 //!  directory where the servers
 //!  binary is placed"
 //! ```
-//!
 
 mod loader;
 mod model;