From 84ee3360a5b5b1c17bf1398966f524f65a85422a Mon Sep 17 00:00:00 2001 From: DarkWiiPlayer Date: Wed, 10 Aug 2022 10:28:46 +0200 Subject: [PATCH] Extend about section in readme --- readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readme.md b/readme.md index 0ae9d11..af4e57c 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,11 @@ Makes your configs (almost) see-through. Glass is a Lua library that makes it easy to lazy-load configuration files into a Lua table at runtime. Its main purpose is to make accessing different configuration files "transparent" to the programmer. +With Glass, you can index a key in an object in a JSON file in a subdirectory as if indexing a nested table. + +As a side effect, it also decouples the code from the config format: +your program doesn't need to care whether a specific configuration file is in YAML or JSON format as long as the structure is correct. + ## Example Assume the file `app/config/settings.json` exists in your project directory with the content `{"user":{"name":"User"}}`