refactor(readme): improve description

This commit is contained in:
2026-01-16 03:43:08 +01:00
parent 462fd7473b
commit ca5adbea1a

View File

@@ -1,57 +1,46 @@
# cws # cws
A minimal web server. This is a personal project; it is not intended to be a production-ready tool, nor will it ever be. Use it at your own risk. A minimal HTTP web server written in C.
> **Note**: This is a personal project; it is not intended to be a production-ready tool, nor will it ever be. Use it at your own risk.
## Requirements ## Requirements
- [meson](https://mesonbuild.com/index.html) - [libcyaml](https://github.com/tlsa/libcyaml)
- libcyaml
- myclib (on my profile) - myclib (on my profile)
- [doxygen](https://www.doxygen.nl/) - [doxygen](https://www.doxygen.nl/) (optional, for documentation only - requires `dot`)
- Optional, just to build the docs. It requires `dot`.
## How to build ## Build
```bash ```bash
$ meson setup build meson setup build
$ cd build meson compile -C build
$ meson compile
``` ```
And then run `cws`! ## Usage
## Docs 1. Copy `config.yaml` and `www/` directory to your working directory
2. Run `./build/cws`
3. Open `http://localhost:3030` in your browser
## Documentation
```bash ```bash
$ git submodule update --init git submodule update --init
$ doxygen doxygen
``` ```
And then open the `docs/html/index.html`. Then open `docs/html/index.html`.
## Roadmap ## Roadmap
### Doing - [ ] Virtual hosts support
- [ ] Minimal templating engine
- Support for virtual hosts - [ ] IPv6 compatibility
## Todo
- Minimal Templating
- IPv6 compatible
## Performance ## Performance
This test was performed using [goku](https://github.com/jcaromiq/goku). Tested with [goku](https://github.com/jcaromiq/goku) (`-c 400 -d 30`):
<details>
<summary>goku command</summary>
```bash
$ goku -t http://localhost:3030 -c 400 -d 30
```
</details>
```bash ```bash
Concurrency level 400 Concurrency level 400