chore: update readme

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://git.rustybever.be/Chewing_Bever/alex/src/branch/dev)
 
+## [0.2.0](https://git.rustybever.be/Chewing_Bever/alex/src/tag/0.2.0)
+
 ### Added
 
 * Rudimentary signal handling for gently stopping server

Cargo.lock

@@ -10,7 +10,7 @@ checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
 
 [[package]]
 name = "alex"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "chrono",
  "clap",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "alex"
-version = "0.1.0"
+version = "0.2.0"
 description = "Wrapper around Minecraft server processes, designed to complement Docker image installations."
 authors = ["Jef Roosens"]
 edition = "2021"

README.md

@@ -1,3 +1,26 @@
-# mc-wrapper
+# Alex
 
-A wrapper around a standard Minecraft server, written in Rust.
+Alex is a wrapper around a typical Minecraft server process. It acts as the
+parent process, and sits in between the user's input and the server's stdin.
+This allows Alex to support additional commands that execute Rust code.
+
+## Why
+
+The primary usecase for this is backups. A common problem I've had with
+Minecraft backups is that they fail, because the server is writing to one of
+the region files as the backup is being created. Alex solves this be sending
+`save-off` and `save-all` to the server, before creating the tarball.
+Afterwards, saving is enabled again with `save-on`.
+
+## Features
+
+* Create safe backups as gzip-compressed tarballs using the `backup` command
+* Automatically create backups periodically
+* Properly configures the process (working directory, optimisation flags)
+* Configure everything as CLI arguments or environment variables
+
+## Installation
+
+Alex is distributed as statically compiled binaries for Linux amd64 and arm64.
+These can be found
+[here](https://git.rustybever.be/Chewing_Bever/alex/packages).