aboutsummaryrefslogtreecommitdiff
path: root/go/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'go/README.md')
-rw-r--r--go/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/go/README.md b/go/README.md
new file mode 100644
index 0000000..27b03ad
--- /dev/null
+++ b/go/README.md
@@ -0,0 +1,6 @@
+# typdown-go
+
+Go package containing CGO bindings for typdown.
+
+The application including this package must be statically linked.
+An example `build.zig` and `build.zig.zon` is provided to build it with Zig's build.