From a2f6152337a18f25f0a344af87aee2462f7a82ed Mon Sep 17 00:00:00 2001 From: Madeorsk Date: Wed, 27 Nov 2024 17:56:09 +0100 Subject: [PATCH] Add links to official documentation in README. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a4feaf1..355e69b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

- Documentation + Documentation | API

@@ -55,9 +55,14 @@ const zrm = b.dependency("zrm", .{ exe.root_module.addImport("zrm", zrm.module("zrm")); ``` +### Documentation + +A full documentation can be found on [zedd.zeptotech.net/zrm](https://zedd.zeptotech.net/zrm). + ### Examples -Full examples can be found in `tests` directory: +Some examples can be found in `tests` directory: +- [`tests/example.zig`](https://code.zeptotech.net/zedd/zrm/src/branch/main/tests/example.zig) - [`tests/repository.zig`](https://code.zeptotech.net/zedd/zrm/src/branch/main/tests/repository.zig) - [`tests/composite.zig`](https://code.zeptotech.net/zedd/zrm/src/branch/main/tests/composite.zig)