From 6549dcf8e676d7676b1793369331f43ebc241856 Mon Sep 17 00:00:00 2001
From: tastytea <tastytea@tastytea.de>
Date: Sat, 24 Oct 2020 12:09:54 +0200
Subject: [PATCH] Update readme.

---
 README.md | 44 +++++++++++++++-----------------------------
 1 file changed, 15 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 23a1803..b66b587 100644
--- a/README.md
+++ b/README.md
@@ -29,15 +29,16 @@ The API is explained in greater detail at the
 
 Install nginx and
 [fcgiwrap](https://www.nginx.com/resources/wiki/start/topics/examples/fcgiwrap/),
-copy the [example config](https://schlomp.space/tastytea/libravatarserv/src/branch/master/doc/nginx-example.conf) to the nginx configuration directory and edit it
-according to your needs. Other webservers and cgi spawners will also work, of
-course.
+copy the [example config](https://schlomp.space/tastytea/libravatarserv/src/branch/master/doc/nginx-example.conf)
+to the nginx configuration directory and edit it according to your needs. Other
+webservers and cgi spawners will also work, of course.
 
 Add the following DNS records to your nameserver:
-```PLAIN
+``` plain
 _avatars._tcp.example.com.     IN SRV 0 0 80  avatars.example.com
 _avatars-sec._tcp.example.com. IN SRV 0 0 443 avatars.example.com
 ```
+
 `_avatars._tcp.example.com` is for HTTP, `_avatars-sec._tcp.example.com` is for
 HTTPS.
 
@@ -55,14 +56,15 @@ specified fallback in the URL and in the environment variable.
 If you want to support "Mystery persons" (mp/mm) as default avatars, place a
 file named `mp` in the avatar dir. You can use the
 [default libravatar mystery person](https://git.linux-kernel.at/oliver/ivatar/raw/master/ivatar/static/img/mm.png)
-([SVG](https://git.linux-kernel.at/oliver/ivatar/raw/master/ivatar/static/img/mm.svg)), for example.
+([SVG](https://git.linux-kernel.at/oliver/ivatar/raw/master/ivatar/static/img/mm.svg)),
+for example.
 
-Test your setup on https://www.libravatar.org/tools/check/.
+Test your setup on <https://www.libravatar.org/tools/check/>.
 
 ### Example
 
 The avatar directory could look like this:
-```PLAIN
+``` plain
 /usr/share/libravatarserv
 ├── [ 32K]  default
 ├── [ 759]  user@example.com
@@ -102,10 +104,10 @@ Default: 0
 
 ### Things to keep in mind
 
-libravatarserv resizes images on the fly and does not cache anything. It also
-calculates both MD5 and SHA256 hashes for every user on every request. This
-could seriously strain the ressources of your computer if many users use the
-service.
+libravatarserv resizes images on the fly and calculates both MD5 and SHA256
+hashes for every user on every request. This could seriously strain the
+ressources of your computer if many users use the service. Make sure to set up
+caching if you expect more than occasional traffic.
 
 ## Install
 
@@ -114,21 +116,6 @@ service.
 Gentoo ebuilds are available via my
 [repository](https://schlomp.space/tastytea/overlay).
 
-### Automatically generated packages
-
-Binary packages are generated automatically for each
-[release](https://schlomp.space/tastytea/libravatarserv/releases) in the
-formats:
-
-* deb
-* rpm
-* tar.gz
-
-They are generated on Debian Stretch 64 bit and signed with my
-[automatic signing key](https://tastytea.de/tastytea_autosign.asc).
-
-Up to and including 0.6.2, the packages were generated on Ubuntu 16.04 64 bit.
-
 ### From source
 
 #### Dependencies
@@ -147,9 +134,8 @@ libmagick++-dev libxdg-basedir-dev` and
 
 #### Compile
 
-```SH
-mkdir build
-cd build
+``` shell
+mkdir build && cd build
 cmake ..
 make
 make install