Skip to content

Commit 9de6a2a

Browse files
committed
Add doc link to README
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
1 parent c32fcaf commit 9de6a2a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# luaz
66

77
[![CI](https://github.com/mxpv/luaz/actions/workflows/ci.yml/badge.svg)](https://github.com/mxpv/luaz/actions/workflows/ci.yml)
8+
[![Docs](https://github.com/mxpv/luaz/actions/workflows/docs.yml/badge.svg)](https://github.com/mxpv/luaz/actions/workflows/docs.yml)
89

910
`luaz` is a zero-cost wrapper library for [`Luau`](https://github.com/luau-lang/luau).
1011
Unlike other libraries, it focuses specifically on `Luau`, providing idiomatic `Zig` bindings that leverage Luau's unique
@@ -26,6 +27,12 @@ These tools make it easy to compile, analyze, and embed Luau scripts directly in
2627
- Built-in Luau tools (`luau-compile` and `luau-analyze`) provided by the build system.
2728
- Excellent test coverage and API documentation.
2829

30+
## 📚 Documentation
31+
32+
Full API documentation is available at: https://mxpv.github.io/luaz/#luaz.lua
33+
34+
The documentation is automatically updated on every change to the `main` branch.
35+
2936
## 📖 Usage Examples
3037

3138
### Basic Usage

0 commit comments

Comments
 (0)