Merge pull request #3 from techatrix/dev

modernize this port

Author: kristoff-it

.github/workflows/ci.yaml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        zig-version: [latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        include:
+          - zig-version: "master"
+            os: ubuntu-latest
+          - zig-version: 0.15.2
+            os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.zig-version == 'master' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Zig
+        uses: mlugg/setup-zig@v2
+        with:
+          version: ${{ matrix.zig-version }}
+
+      - name: Check Formatting
+        run: zig fmt --ast-check --check .
+
+      - name: Build
+        run: zig build --summary new

README.md

@@ -1,4 +1,25 @@
+[![CI](https://github.com/allyourcodebase/harfbuzz/actions/workflows/ci.yaml/badge.svg)](https://github.com/allyourcodebase/harfbuzz/actions)
+
 # harfbuzz
 
 This is [harfbuzz](https://harfbuzz.github.io/) packaged for [Zig](https://ziglang.org/).
 
+## Installation
+
+First, update your `build.zig.zon`:
+
+```
+# Initialize a `zig build` project if you haven't already
+zig init
+zig fetch --save git+https://github.com/allyourcodebase/harfbuzz.git
+```
+
+You can then import `harfbuzz` in your `build.zig` with:
+
+```zig
+const harfbuzz_dependency = b.dependency("harfbuzz", .{
+    .target = target,
+    .optimize = optimize,
+});
+your_exe.root_module.linkLibrary(harfbuzz_dependency.artifact("harfbuzz"));
+```