Skip to content

Commit aea5ed5

Browse files
committed
docs(readme): sync module descriptions
1 parent ed61252 commit aea5ed5

1 file changed

Lines changed: 25 additions & 17 deletions

File tree

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Mods
22

3-
**Mods** is a pure Lua utility library with predictable APIs, 💤 lazy-loaded
4-
inter-module dependencies, and support for Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT.
3+
**Mods** is a pure Lua utility library with predictable APIs and support for Lua
4+
5.1, 5.2, 5.3, 5.4, and LuaJIT.
55

66
> [!IMPORTANT]
77
>
@@ -47,21 +47,25 @@ luarocks install mods
4747
4848
## Modules
4949

50-
| Module | Description |
51-
| -------------- | -------------------------------------------------------------- |
52-
| [`is`] | Type predicates for Lua values and filesystem path types. |
53-
| [`keyword`] | Lua keyword helpers. |
54-
| [`List`] | Python-style list helpers for mapping, filtering, and slicing. |
55-
| [`operator`] | Operator helpers as functions. |
56-
| [`repr`] | Render any Lua value as a readable string. |
57-
| [`runtime`] | Exposes Lua runtime metadata and version compatibility flags. |
58-
| [`Set`] | Set operations and helpers for unique values. |
59-
| [`str`] | String utility helpers modeled after Python's `str`. |
60-
| [`stringcase`] | String case conversion helpers. |
61-
| [`tbl`] | Utility functions for working with Lua tables. |
62-
| [`template`] | Interpolate string placeholders of the form `{{...}}`. |
63-
| [`utils`] | Small shared utility helpers used by modules in this library. |
64-
| [`validate`] | Validation checks for values and filesystem path types. |
50+
| Module | Description |
51+
| -------------- | ------------------------------------------------------------------- |
52+
| [`fs`] | Filesystem I/O and metadata operations. |
53+
| [`is`] | Type predicates for Lua values and filesystem path types. |
54+
| [`keyword`] | Lua keyword helpers. |
55+
| [`List`] | A list class with common sequence operations. |
56+
| [`ntpath`] | Lexical path operations for Windows/NT-style paths. |
57+
| [`operator`] | Operator helpers as functions. |
58+
| [`path`] | Generic cross-platform path API. |
59+
| [`posixpath`] | Lexical path operations for POSIX-style paths. |
60+
| [`repr`] | Render any Lua value as a readable string. |
61+
| [`runtime`] | Exposes Lua runtime metadata and version compatibility flags. |
62+
| [`Set`] | A set class with common operations on unique values. |
63+
| [`str`] | String utility helpers modeled after Python's `str`. |
64+
| [`stringcase`] | String case conversion helpers. |
65+
| [`tbl`] | Utility functions for working with Lua tables. |
66+
| [`template`] | Interpolate string placeholders of the form `{{...}}`. |
67+
| [`utils`] | Small shared utility helpers used by modules in this library. |
68+
| [`validate`] | Validation checks for values and filesystem path types. |
6569

6670
> [!NOTE]
6771
>
@@ -76,10 +80,14 @@ Thanks to these Lua ecosystem projects:
7680
representation.
7781
- [busted](https://github.com/lunarmodules/busted) for test framework support.
7882

83+
[`fs`]: https://luamod.github.io/mods/modules/fs
7984
[`is`]: https://luamod.github.io/mods/modules/is
8085
[`keyword`]: https://luamod.github.io/mods/modules/keyword
8186
[`List`]: https://luamod.github.io/mods/modules/list
87+
[`ntpath`]: https://luamod.github.io/mods/modules/ntpath
8288
[`operator`]: https://luamod.github.io/mods/modules/operator
89+
[`path`]: https://luamod.github.io/mods/modules/path
90+
[`posixpath`]: https://luamod.github.io/mods/modules/posixpath
8391
[`repr`]: https://luamod.github.io/mods/modules/repr
8492
[`runtime`]: https://luamod.github.io/mods/modules/runtime
8593
[`Set`]: https://luamod.github.io/mods/modules/set

0 commit comments

Comments
 (0)