From fac8c577c1010ef291c615f1b226b0ece1b69663 Mon Sep 17 00:00:00 2001
From: OniriCorpe <oniricorpe@disroot.org>
Date: Sat, 7 May 2022 23:13:33 +0200
Subject: [PATCH] enhanced description & disclaimer

---
 README.md          | 27 +++++++++++++++++++--------
 README_fr.md       | 27 +++++++++++++++++++--------
 doc/DESCRIPTION.md | 10 ++++++++++
 doc/DISCLAIMER.md  | 18 +++++++++---------
 4 files changed, 57 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 367798b..540e69a 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,16 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 A gemini server written in rust.
 
+### Features
+
+- Vhosts
+- CGI
+- User directories
+- Reverse proxy
+- Redirect
+- SCGI
+- Reload config on SIGHUP
+
 
 **Shipped version:** 0.6.6~ynh1
 
@@ -24,16 +34,16 @@ A gemini server written in rust.
 
 ## Disclaimers / important information
 
-* Other infos that people should be aware of, such as:
-    * Redirect TCP/1965 port to the server
-    * To add a gemini capsule, create a /etc/gemserv/config.d/example.toml 
+Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
 
-```
+To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
+
+``` toml
 [[server]]
-hostname = "youdomain.org"
-dir = "/path/to/serv/"
-key = "/etc/yunohost/certs/youdomain.org/key.pem"
-cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
+hostname = "yourdomain.org"
+dir = "/path/to/serv"
+key = "/etc/yunohost/certs/yourdomain.org/key.pem"
+cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
 # index is optional but defaults to index.gemini. The server will serve files
 # ending in gemini or gmi.
 index = "index.gmi"
@@ -59,6 +69,7 @@ proxy_all = localhost:1967
 # redirect is optional
 redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
 ```
+
 ## Documentation and resources
 
 * Upstream app code repository: https://git.sr.ht/~int80h/gemserv
diff --git a/README_fr.md b/README_fr.md
index 59ab23f..10ce62e 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -13,6 +13,16 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
 
 A gemini server written in rust.
 
+### Features
+
+- Vhosts
+- CGI
+- User directories
+- Reverse proxy
+- Redirect
+- SCGI
+- Reload config on SIGHUP
+
 
 **Version incluse :** 0.6.6~ynh1
 
@@ -20,16 +30,16 @@ A gemini server written in rust.
 
 ## Avertissements / informations importantes
 
-* Other infos that people should be aware of, such as:
-    * Redirect TCP/1965 port to the server
-    * To add a gemini capsule, create a /etc/gemserv/config.d/example.toml 
+Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
 
-```
+To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
+
+``` toml
 [[server]]
-hostname = "youdomain.org"
-dir = "/path/to/serv/"
-key = "/etc/yunohost/certs/youdomain.org/key.pem"
-cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
+hostname = "yourdomain.org"
+dir = "/path/to/serv"
+key = "/etc/yunohost/certs/yourdomain.org/key.pem"
+cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
 # index is optional but defaults to index.gemini. The server will serve files
 # ending in gemini or gmi.
 index = "index.gmi"
@@ -55,6 +65,7 @@ proxy_all = localhost:1967
 # redirect is optional
 redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
 ```
+
 ## Documentations et ressources
 
 * Dépôt de code officiel de l'app : https://git.sr.ht/~int80h/gemserv
diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md
index 241011b..9ab8c38 100644
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@@ -1 +1,11 @@
 A gemini server written in rust.
+
+### Features
+
+- Vhosts
+- CGI
+- User directories
+- Reverse proxy
+- Redirect
+- SCGI
+- Reload config on SIGHUP
diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md
index b7bbd18..ced6501 100644
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@@ -1,13 +1,13 @@
-* Other infos that people should be aware of, such as:
-    * Redirect TCP/1965 port to the server
-    * To add a gemini capsule, create a /etc/gemserv/config.d/example.toml 
+Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
 
-```
+To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
+
+``` toml
 [[server]]
-hostname = "youdomain.org"
-dir = "/path/to/serv/"
-key = "/etc/yunohost/certs/youdomain.org/key.pem"
-cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
+hostname = "yourdomain.org"
+dir = "/path/to/serv"
+key = "/etc/yunohost/certs/yourdomain.org/key.pem"
+cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
 # index is optional but defaults to index.gemini. The server will serve files
 # ending in gemini or gmi.
 index = "index.gmi"
@@ -32,4 +32,4 @@ proxy = { path = "localhost:1966" }
 proxy_all = localhost:1967
 # redirect is optional
 redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
-```
\ No newline at end of file
+```