darkwiiplayer/glass
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme to reflect latest changes

Browse source
This commit is contained in:
Talia 2024-08-20 15:58:25 +02:00
parent f99667fbf5
commit 0d98808eb5
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
readme.md
View file

@ -31,6 +31,7 @@ Glass offers the following loaders out of the box:
* `csv` loads csv files (with header line) * `csv` loads csv files (with header line)
* `discount` loads markdown files\*. * `discount` loads markdown files\*.
* `environment` loads environment variables. * `environment` loads environment variables.
* `fennel` loads and executes fennel files.
* `json` loads a JSON file as a Lua table. (requires `cjson`) * `json` loads a JSON file as a Lua table. (requires `cjson`)
* `lua` loads and executes a Lua file. * `lua` loads and executes a Lua file.
* `moonhtml` loads a MoonHTML template and returns it as a function. * `moonhtml` loads a MoonHTML template and returns it as a function.
@ -53,6 +54,8 @@ file and attempts to load it into a Lua value.
Loaders will typically add an extension to the given file name before checking Loaders will typically add an extension to the given file name before checking
whether that file exists and can be loaded. whether that file exists and can be loaded.
When a loader cannot find the expected file, it should return `nil` to let glass A successful loader should return `true` followed by its result.
continue the loader chain. When a loader returns a truthy value, this will be When a loader can't load a key, it should return `false` and an optional
used and no further loaders will be tried. description of why.
When a loader encounters an error (file found but can't be parsed), it should
error.