Skip to content

Commit 1dfe071

Browse files
committed
docs: update readme
1 parent ab83287 commit 1dfe071

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

readme.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,17 @@ Like the Lua C API, the ziglua API "emphasizes flexibility and simplicity... com
99

1010
## Why use ziglua?
1111

12-
In a nutshell, ziglua is a simple wrapper around the C API you would get by using `@cImport()` to bind Lua. ziglua aims to mirror the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4) as closely as possible, while improving ergonomics using Zig's features. For example:
12+
In a nutshell, ziglua is a simple wrapper around the C API you would get by using Zig's `@cImport()`. ziglua aims to mirror the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4) as closely as possible, while improving ergonomics using Zig's features. For example:
1313

14-
* Zig error unions to enforce failure state handling
14+
* Zig error unions to require failure state handling
1515
* Null-terminated slices instead of C strings
1616
* Type-checked enums for parameters and return values
1717
* Compiler-enforced checking of optional pointers
18-
* Functions return `bool` rather than `int` to indicate success
18+
* More precise types (e.g. `bool` instead of `int`)
1919

20-
While there are some helper functions added to complement the C API, ziglua aims to remain low-level.
21-
This allows full access to Lua with the added benefits of Zig's improvements over C.
20+
While there are some helper functions added to complement the C API, ziglua aims to remain low-level. This allows full access to the Lua API through a layer of Zig's improvements over C.
2221

23-
If you want something higher-level, perhaps try [zoltan](https://github.com/ranciere/zoltan).
22+
If you want something higher-level (but doesn't expose the full API), perhaps try [zoltan](https://github.com/ranciere/zoltan).
2423

2524
## Getting Started
2625

0 commit comments

Comments
 (0)