Skip to content

Commit

Permalink
update README: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
renerocksai committed Jan 10, 2024
1 parent f4563f2 commit 23b70b8
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,26 @@ 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.
- A: Run `zig build run-docserver` to serve them locally.
- 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`
- Q: **Are there API docs?**
- A: They are under development. Git clone this, then run `zig build run-docserver`.
- 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

Expand Down

0 comments on commit 23b70b8

Please sign in to comment.