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

added hints to API-docs to README

Browse source
This commit is contained in:
Rene Schallner 2023-12-30 00:59:00 +01:00
parent 521b0deaf6
commit 8f82a692b1
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -26,8 +26,6 @@ that it proved to be:
Exactly the goals I set out to achieve! Exactly the goals I set out to achieve!
## <mark>**Zap depends on the latest stable release of Zig (0.11)**</mark>
## Most FAQ: ## Most FAQ:
- Q: **Does ZAP work on Windows?** - Q: **Does ZAP work on Windows?**
@ -37,6 +35,8 @@ Exactly the goals I set out to achieve!
- 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. [https](./examples/https/https.zig) example.
- Q: **Are there API docs?**
- A: They are under development. Git clone this, then run `zig build run-docserver`.
## Here's what works ## Here's what works
@ -44,6 +44,10 @@ I recommend checking out **Endpoint-based examples for more realistic
use-cases**. Most of examples are super-stripped-down to only include what's use-cases**. Most of examples are super-stripped-down to only include what's
necessary to show a feature. necessary to show a feature.
**NOTE: To see API docs, run `zig build run-docserver`.** To specify a custom
port and docs dir: `zig build docserver && zig-out/bin/docserver --port=8989
--docs=path/to/docs`.
- **Super easy build process**: Zap's `build.zig` now uses the new Zig package - **Super easy build process**: Zap's `build.zig` now uses the new Zig package
manager for its C-dependencies, no git submodules anymore. manager for its C-dependencies, no git submodules anymore.
- _tested on Linux and macOS (arm, M1)_ - _tested on Linux and macOS (arm, M1)_
@ -203,7 +207,7 @@ code leaks memory.
## Getting started ## Getting started
Make sure you have **the latest zig release (0.11.0)** installed. Fetch it from Make sure you have zig 0.12.0 installed. Fetch it from
[here](https://ziglang.org/download). [here](https://ziglang.org/download).
```shell ```shell
@ -217,6 +221,8 @@ $ # open http://localhost:3000 in your browser
## Using ⚡zap⚡ in your own projects ## Using ⚡zap⚡ in your own projects
## NOTE, WHILE THIS IS ITS OWN 0.12.0 BRANCH, THIS SECTION WON'T GET UPDATED
Make sure you have **the latest zig release (0.11.0)** installed. Fetch it from Make sure you have **the latest zig release (0.11.0)** installed. Fetch it from
[here](https://ziglang.org/download). [here](https://ziglang.org/download).