yini-cli 1.0.1-beta.1 → 1.0.3-beta

package/README.md

@@ -11,25 +11,92 @@
 - **YINI is an alternative** to other great config formats like INI, JSON, YAML, XML, and TOML — designed for clarity, simplicity, and straightforward section nesting.
 - **Started as a personal project and a research challenge:** Provides structure similar to INI, with features inspired by JSON and YAML.
 - **Built for clarity:**
-    * Uses minimal syntax for humans, especially for nested sections.
-    * Uses a concise syntax, aims to not have too much syntax noise.
+    * Uses concise syntax designed for clarity, especially in nested sections.
     * Supports commonly used configuration structures.
-- *Originated from practical needs **for configuration clarity, simplicity, minimalism, and flexibility**.
+- *Developed to meet practical needs, driven by curiosity and a desire **for configuration clarity, simplicity, minimalism, and flexibility**.
 
 ---
 
 ## 💡 What is YINI?
 - **INI-inspired** — with added support for typing, comments, and nested sections.
-- **Uses minimal syntax** — minimal syntax noise, maximum clarity.
+- **Uses minimal syntax** — yet aims to keep maximum clarity.
 - Section nesting **without requiring indentation or dot-delimited keys**.
 - **Supports strict and lenient modes**, and all major data types.
 - Designed for compatibility with both **manual editing** and **automation**.
-- 👉 See [how YINI compares to JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
+- 👉 See [how YINI differs from JSON, YAML, INI, and TOML](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples/compare-formats.md).
 - Want the full syntax reference? See the [YINI Specification](https://github.com/YINI-lang/YINI-spec).
 
 ---
 
-## Intro to YINI Config Format
+## Quick Into to YINI Format
+
+YINI code looks like this:
+```yini
+    // This is a comment in YINI
+    // YINI is a simple, human-readable configuration file format.
+
+    // Note: In YINI, spaces and tabs don't change meaning - indentation is just
+    // for readability.
+
+    /*  This is a block comment
+
+        In YINI, section headers use repeated characters "^" at the start to
+        show their level: (Section header names are case-sensitive.)
+
+        ^ SectionLevel1
+        ^^ SectionLevel2
+        ^^^ SectionLevel3
+    */
+
+    ^ App                      // Definition of section (group) "App" 
+      name     = 'My Title'    // Keys and values are written as key = value
+      items    = 25
+      darkMode = true          // "ON" and "YES" works too
+
+        // Sub-section of the "App" section
+        ^^ Special
+           primaryColor = #336699   // Hex number format
+           isCaching    = false     // "OFF" and "NO" works too
+```
+
+**The above YINI converted to a JS object:**
+```js
+{
+    App: {
+        name: 'My Title',
+        items: 25,
+        darkMode: true,
+        Special: { 
+            primaryColor: 3368601,
+            isCaching: false
+        }
+    }
+}
+```
+
+**In JSON:**
+```json
+{
+   "App":{
+      "name":"My Title",
+      "items":25,
+      "darkMode":true,
+      "Special":{
+         "primaryColor":3368601,
+         "isCaching":false
+      }
+   }
+}
+```
+
+That's it!
+
+- ▶️ Link to [examples/](https://github.com/YINI-lang/yini-parser-typescript/tree/main/examples) files.
+- ▶️ Link to [Demo Apps](https://github.com/YINI-lang/yini-demo-apps/tree/main) with complete basic usage.
+
+---
+
+## Bigger Intro into YINI Config Format
 **YINI** is a simple and readable configuration format. Sections are defined with `^ SectionName`, and values are assigned using `key = value`. The format supports common data types (same as those found in JSON), including strings, numbers, booleans, nulls, and lists. 
 
 To learn more, see the [Getting Started: Intro to YINI Config Format](https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md) tutorial.
@@ -40,7 +107,7 @@ To learn more, see the [Getting Started: Intro to YINI Config Format](https://gi
 
 ### Installation
 
-1. **Install it globally from npm**  
+1. **Install it globally from npm — (requires Node.js)**  
     Open your terminal and run:
     ```
     npm install -g yini-cli
@@ -63,10 +130,10 @@ To learn more, see the [Getting Started: Intro to YINI Config Format](https://gi
     Create a simple test file, for example: `config.yini`:
     ```yini
     ^ App
-    name = "My App Title"
-    version = "1.2.3"
-    pageSize = 25
-    darkTheme = off
+      name = "My App Title"
+      version = "1.2.3"
+      pageSize = 25
+      darkTheme = off
     ```
 
     Then run:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "yini-cli",
-    "version": "1.0.1-beta.1",
+    "version": "1.0.3-beta",
     "description": "CLI for parsing and validating YINI config files: type-safe values, nested sections, comments, minimal syntax noise, and optional strict mode.",
     "keywords": [
         "yini",
@@ -68,7 +68,7 @@
     "author": "Marko K. Seppänen",
     "dependencies": {
         "commander": "^14.0.0",
-        "yini-parser": "^1.0.1-beta"
+        "yini-parser": "^1.1.0-beta"
     },
     "devDependencies": {
         "@eslint/js": "^9.31.0",

package/sample.yini

@@ -4,16 +4,16 @@
     Example of a YINI document.
 */
 
-^ Service               // Defines a section named Service.
+^ Service                   // Defines a section named Service.
 Enabled = true
 
-    ^^ Cache
-    Type = "redis"          // Defines Cache, a sub-section of Server.
+    ^^ Cache                // Defines Cache, a sub-section of Server.
+    Type = "redis"
     TTL = 3600
 
-        ^^^ Options             // Defines Options, a sub-section of Cache.
+        ^^^ Options         // Defines Options, a sub-section of Cache.
         Host = "127.0.0.1"
         Port = 6379
 
-^ Env                   // Defines a section named Env.
+^ Env                       // Defines a section named Env.
 code = "dev"