Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
chung-leong committed Apr 22, 2024
1 parent da8ad6c commit 5be147b
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,29 @@
A software tool set that lets you utilize [Zig](https://ziglang.org/) code in your JavaScript
project.

Consult [the project wiki](https://github.com/chung-leong/zigar/wiki) for more details.
Consult the [project wiki](https://github.com/chung-leong/zigar/wiki) for more details.

## Features

* Support for nearly all Zig data types
* Support for MacOS, Linux, and Windows (both 64-bit and 32-bit)
* Support for Node.js, Electron, and NW.js (native code execution)
* Support for Webpack, Rollup, and Vite (WebAssembly)

## Versioning

[RELEASE PENDING]

The major and minor version numbers of Zigar correspond to the version of the Zig compiler
it's designed for. The current version is 0.11.1. It works with Zig 0.11.0.

Due to the long development cycle of 0.11.1, support for 0.12.0 has also been baked in. A version
specific to Zig 0.12.0, without the backward-compatbility code, will be released in the near
future.

## Technical support

If you have questions concerning this project, please post them at this project's
[discussion section](https://github.com/chung-leong/zigar/discussions). I can also be contacted at
[ziggit.dev](https://ziggit.dev/), which also happens to be an excellent forum for finding help on
all matters related to the Zig language.

0 comments on commit 5be147b

Please sign in to comment.