mirrors/zap
1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-20 15:14:08 +00:00
Code Activity

update README: docs

Browse source
This commit is contained in:
Rene Schallner 2024-01-10 15:49:11 +01:00
parent e257ca6a43
commit ababe017a9
1 changed files with 16 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -29,22 +29,25 @@ Exactly the goals I set out to achieve!
## Most FAQ: ## 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?** - Q: **Zap doesn't build with Zig master?**
- A: See the 0.12.0 branch. An example of how to use it is - 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 [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 branch is not the official master branch of ZAP. Yet. Until zig 0.12.0 is
released. released.
- Q: **Does ZAP work on Windows?** - Q: **Does ZAP work on Windows?**
- A: No. This is due to the underlying facil.io C library. Future versions of - 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 facil.io might support Windows but there is no timeline yet. Your best options
on Windows are WSL2 or a docker container. on Windows are WSL2 or a docker container.
- Q: **Does ZAP support TLS / HTTPS?** - Q: **Does ZAP support TLS / HTTPS?**
- A: Yes, ZAP supports using the system's openssl. See the - A: Yes, ZAP supports using the system's openssl. See the
[https](./examples/https/https.zig) example and make sure to build with [https](./examples/https/https.zig) example and make sure to build with the
the `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`: `-Dopenssl` flag or the environment variable `ZAP_USE_OPENSSL=true`:
- `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap" .{...})`) - `.openssl = true,` (in dependent projects' build.zig, `b.dependency("zap"
- `ZAP_USE_OPENSSL=true zig build https` .{...})`)
- `zig build -Dopenssl=true https` - `ZAP_USE_OPENSSL=true zig build https`
- `zig build -Dopenssl=true https`
## Here's what works ## Here's what works