Skip to content

Commit edcab62

Browse files
committed
Improve readme
1 parent bd3ef76 commit edcab62

1 file changed

Lines changed: 30 additions & 11 deletions

File tree

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,34 @@
1010

1111
# [Kvarn](https://kvarn.org/)
1212

13-
> An extensible and efficient forward-thinking web server.
14-
15-
Kvarn is an extendable backend library with [native async everywhere](https://kvarn.org/extensions/);
16-
[zero downtime](https://kvarn.org/features/#graceful-shutdown--handover); and
17-
[safe & fast defaults](https://kvarn.org/features/#sane-defaults).
18-
19-
Kvarn is batteries-included (optional defaults) with support for reverse proxying, auto HTTP/2 push,
20-
in-memory caching (proper cache invalidation), server communication through [`kvarnctl`](https://github.com/Icelk/kvarn/tree/main/ctl/),
21-
and easy website creation through Markdown and [Chute](https://github.com/Icelk/kvarn/tree/main/chute/).
13+
<blockquote style="display: inline-block; margin: 0 1rem">
14+
<b
15+
>A forward-thinking fast web server designed to fit
16+
<i>your</i> needs, efficiently.</b
17+
>
18+
</blockquote>
19+
<p>
20+
Kvarn is a <a href="https://rust-lang.org">rusty</a>,
21+
<a href="https://github.com/Icelk/kvarn/blob/main/LICENSE"
22+
>open-source</a
23+
>, extendable web application framework with
24+
<a href="https://kvarn.org/extensions/">native async everywhere</a>;
25+
<a href="https://kvarn.org/features/#graceful-shutdown--handover"
26+
>zero downtime</a
27+
>; and
28+
<a href="https://kvarn.org/features/#sane-defaults"
29+
>safe &amp; fast defaults</a
30+
>.
31+
</p>
32+
<p>
33+
Kvarn is batteries-included (optional defaults) with support for
34+
<b>automatic HTTPS certificates</b>, <b>HTTP/3</b>, io_uring everywhere,
35+
reverse proxying, auto HTTP/2 push, in-memory caching (proper cache
36+
invalidation), server communication provided by
37+
<a href="https://github.com/Icelk/kvarn/tree/main/ctl/">a simple CLI</a
38+
>, and easy website creation through Markdown and
39+
<a href="https://github.com/Icelk/kvarn/tree/main/chute/">Chute</a>.
40+
</p>
2241

2342
If you're looking for an **executable** to run your webserver with, see [Mölla](https://github.com/Icelk/moella).
2443
Using Mölla, you can configure your host(s), add a search engine, authentication, and other parts of the
@@ -36,7 +55,7 @@ If you need to develop custom extension (like [those on icelk.dev](https://githu
3655
you need to compile Kvarn yourself. Luckily,
3756
[Mölla makes it easy to add custom extensions](https://github.com/Icelk/icelk.dev/blob/659df7f19b2ac22efbe4d20f0978c9f58964c76b/server/src/main.rs#L13-L21).
3857

39-
To use the latest and greatest you can add Kvarn as a git dependency:
58+
To use the latest and greatest you can add Kvarn as a git dependency, though the latest version is recommended:
4059

4160
```ini
4261
[dependencies]
@@ -45,7 +64,7 @@ kvarn = { git = "https://github.com/Icelk/kvarn" }
4564

4665
## Dependencies
4766

48-
To increase security, build-times, reliability, and speed, I use the minimal reasonable number of dependencies.
67+
To increase security, build-times, reliability, and speed, I use dependencies sparingly.
4968

5069
The two heavy-hitters are `tokio` (async runtime for async networking, file access, and extensions) and `rustls` (for encryption, optional if you want to run a unsafe (often local) web server).
5170
`brotli` and `flate2` are enabled by default to provide compression, but can be turned off.

0 commit comments

Comments
 (0)