From ababe017a925a5f5310fbce3565e902cd5fc9932 Mon Sep 17 00:00:00 2001 From: Rene Schallner Date: Wed, 10 Jan 2024 15:49:11 +0100 Subject: [PATCH] update README: docs --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e6b94b2..e9f3459 100644 --- a/README.md +++ b/README.md @@ -29,22 +29,25 @@ Exactly the goals I set out to achieve! ## Most FAQ: +- Q: **Where is the API documentation?** + - A: Docs are a work in progress. You can check them out [here](https://zigzap.org/zap). The docs are based on the `zig-0.12.0` branch but apply to the current release (zig 0.11.0), too. - Q: **Zap doesn't build with Zig master?** -- A: See the 0.12.0 branch. An example of how to use it is - [here](https://github.com/zigzap/hello-0.12.0). Please note that the 0.12.0 - branch is not the official master branch of ZAP. Yet. Until zig 0.12.0 is - released. + - A: See the 0.12.0 branch. An example of how to use it is + [here](https://github.com/zigzap/hello-0.12.0). Please note that the 0.12.0 + branch is not the official master branch of ZAP. Yet. Until zig 0.12.0 is + released. - Q: **Does ZAP work on Windows?** -- A: No. This is due to the underlying facil.io C library. Future versions of - facil.io might support Windows but there is no timeline yet. Your best options - on Windows are WSL2 or a docker container. + - A: No. This is due to the underlying facil.io C library. Future versions of + facil.io might support Windows but there is no timeline yet. Your best options + on Windows are WSL2 or a docker container. - Q: **Does ZAP support TLS / HTTPS?** -- A: Yes, ZAP supports using the system's openssl. See the - [https](./examples/https/https.zig) example and make sure to build with - the `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`: - - `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap" .{...})`) - - `ZAP_USE_OPENSSL=true zig build https` - - `zig build -Dopenssl=true https` + - A: Yes, ZAP supports using the system's openssl. See the + [https](./examples/https/https.zig) example and make sure to build with the + `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`: + - `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap" + .{...})`) + - `ZAP_USE_OPENSSL=true zig build https` + - `zig build -Dopenssl=true https` ## Here's what works