From a3f433ad2d8d647d3c94b5ece9160707b4ffdbb5 Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Fri, 2 Sep 2022 12:02:26 +0300 Subject: [PATCH] [readme] Add how to get help section, add Discord channel invite link. --- documentation/readme.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/documentation/readme.rst b/documentation/readme.rst index 22b0e66..ac0a7fc 100644 --- a/documentation/readme.rst +++ b/documentation/readme.rst @@ -19,6 +19,28 @@ kawipiko -- blazingly fast static HTTP server +.. highlights:: + + Table of contents: + + * `Manual <#manual>`__ and `Examples <#examples>`__ + * `Installation <#installation>`__ and `FAQ <#faq>`__ + * `Features <#features>`__ and `Benchmarks <#benchmarks>`__ + * `About <#about>`__, `Copyright and licensing <#notice-copyright-and-licensing>`__, and `References <#references>`__ + * `chat on Discord `__, `discuss on GitHub `__, or `email author `__ + + + + +-------- + + + + +About +===== + + ``kawipiko`` is a **lightweight static HTTP server** written in Go; focused on serving static content **as fast and efficient as possible**, with the **lowest latency**, and with the lowest resource consumption (either CPU, RAM, IO); @@ -442,6 +464,24 @@ FAQ +How to ask for help? +-------------------- + +If you have encountered a bug, +just use the `GitHub issues `__. + +If you are not sure about something, +want to give feedback, +or request new features, +just use the `GitHub discussions `__. + +If you want to ask a quick question, +or just have a quick chat, +just head over to the `Discord channel `__. + + + + Is it production ready? -----------------------