doc: add getting started

Author: typesafe

README.md

@@ -4,6 +4,22 @@ Thanks to its conventions-based approach it bridges the gap seamlessly, with alm
 ![build-badge](https://img.shields.io/github/actions/workflow/status/typesafe/node-api-zig/ci.yml)
 ![test-badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Ftypesafe%2F26882516c7ac38bf94a81784f966bd86%2Fraw%2Fnode-api-zig-test-badge.json)
 
+## Features
+
+- **function mapping**, including async support (auto-conversion to Promises)
+- **class mapping**, incl. support for fields, instance (async) methods, satic (async) methods.
+- **auto-wrapping** of native objects instances, similar to defining classes but for instances created in native Zig code
+- **memory management** with convention-based `init`, `deinit` support & `allocator` injection
+- `errorunion` support
+- mapping JS values
+  - by value: through (de)serialization or various types
+  - by reference
+    - Zig-managed values: through pointers to (wrapped) native Zig values
+    - JS-managed values: through wrappers types (`NodeValue` et.al.) for read/write
+  - typesafe callbacks: `NodeFunction(fn (u32, u32) !u32)`
+
+## Example
+
 ```zig
 const node_api = @import("node-api");
 const Options = @import("Options");
@@ -47,23 +63,55 @@ TODO:
   - [ ] `ExternalArrayBuffer`
 - [ ] Use `Result(T, E)` as alternative to `errorunion`s for improved error messages.
 
-# Features
+# Getting started
 
-- **function mapping**, including async support (auto-conversion to Promises)
-- **class mapping**, incl. support for fields, instance methods, satic methods
-- **auto-wrapping** of native objects instances, similar to defining classes but for instances created in native Zig code
-- **memory management** with convention-based `init`, `deinit` support & `allocator` injection
-- `errorunion` support
-- mapping JS values
-  - by value: through (de)serialization or various types
-  - by reference
-    - Zig-managed values: through pointers to (wrapped) native Zig values
-    - JS-managed values: through wrappers types (`NodeValue` et.al.) for read/write
-  - typesafe callbacks: `NodeFunction(fn (u32, u32) !u32)`
+Install the `node_api` (note the underscore) dependency
 
-# Getting started
+```sh
+> zig fetch --save https://github.com/typesafe/node-api-zig/archive/refs/tags/v0.0.3-beta.tar.gz
+```
+
+Add the `node-api` (note the hyphen) module to your library.
+
+```zig
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const mod = b.addModule("root", .{
+        .root_source_file = b.path("src/root.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const node_api = b.dependency("node_api", .{});
+    mod.addImport("node-api", node_api.module("node-api"));
 
-TODO
+    const lib = b.addLibrary(.{
+        // needed on Linux
+        .use_llvm = true,
+        .name = "my-native-node-library",
+        .root_module = mod,
+    });
+
+    b.installArtifact(lib);
+}
+```
+
+Initialize your Node-API extension:
+
+```zig
+const std = @import("std");
+const node = @import("node-api");
+
+comptime {
+    node.@"export"(.{
+      // functions, types (for classes), values
+     });
+}
+```
 
 # Features
 

build.zig

@@ -32,7 +32,7 @@ pub fn build(b: *std.Build) void {
                     .directory => {
                         std.log.info("tests/zig_modules/{s}/src/root.zig", .{entry.name});
 
-                        const mod = b.addLibrary(.{
+                        const lib = b.addLibrary(.{
                             // imprtant, works without on MacOS, but not on Linux
                             .use_llvm = true,
                             .linkage = .dynamic,
@@ -43,11 +43,11 @@ pub fn build(b: *std.Build) void {
                                 .target = target,
                             }),
                         });
-                        mod.root_module.addImport("node-api", node_api);
+                        lib.root_module.addImport("node-api", node_api);
 
                         // important
-                        mod.linker_allow_shlib_undefined = true;
-                        mod.linkLibC();
+                        lib.linker_allow_shlib_undefined = true;
+                        lib.linkLibC();
 
                         const sub_path = std.fmt.allocPrint(b.allocator, "{s}.node", .{entry.name}) catch |err| {
                             std.log.info("{s}", .{@errorName(err)});
@@ -57,7 +57,7 @@ pub fn build(b: *std.Build) void {
 
                         build_mods_step.dependOn(
                             &b.addInstallArtifact(
-                                mod,
+                                lib,
                                 .{
                                     // custom dir is relative to ./zig-out
                                     .dest_dir = .{ .override = .{