Add info to README and example config comments

Author: OreQr

README.md

@@ -1,3 +1,57 @@
 # Fake Minecraft Server
 
 [![CI](https://github.com/OreQr/fake-minecraft-server/actions/workflows/ci.yml/badge.svg)](https://github.com/OreQr/fake-minecraft-server/actions/workflows/ci.yml)
+
+Lightweight Rust implementation of a fake Minecraft server. It supports server list responses (status/ping) and connection attempts, useful for testing clients or as a placeholder server.
+
+## Configuration
+
+Server uses a YAML configuration file (`config.yml`). If no configuration is found, default values will be used.
+
+You can specify a custom path to the configuration file by setting the `CONFIG_PATH` environment variable.
+
+Example configuration file with comments is provided in [`config.example.yml`](https://github.com/OreQr/fake-minecraft-server/blob/master/config.example.yml).
+
+### Default values:
+
+```yaml
+debug: false
+
+host: 127.0.0.1
+port: 25565
+
+status:
+  version:
+    same: true
+
+  players:
+    max: 20
+    online: 0
+
+  motd: "§cFake Minecraft Server"
+  favicon: server-icon.png
+
+kick_message: "§c§lThis is a fake server!\n§eIt only responds to ping requests."
+```
+
+## Debugging
+
+To enable debug logging, you can either:
+
+1. Set the environment variable:
+
+   ```bash
+   DEBUG=true
+   # or Rust lang
+   RUST_LOG="debug"
+   ```
+
+2. Or enable debug in the config file:
+
+   ```yaml
+   debug: true
+   ```
+
+## License
+
+[MIT](https://github.com/OreQr/fake-minecraft-server/blob/master/LICENSE)

config.example.yml

@@ -1,22 +1,43 @@
+# Enable debug logging in addition to DEBUG/RUST_LOG environment variable
+debug: false
+
+# IP address the server will listen on
 host: 127.0.0.1
+# Port number the server will listen on (default Minecraft port is 25565)
 port: 25565
 
+# Server status response configuration
 status:
+  # Version information shown in the server list
   version:
+    # Minecraft version string to display
     name: 1.21.5
+    # Protocol version number (see: https://minecraft.wiki/w/Data_version)
     protocol: 770
+    # If true, server will report same version as client
     same: false
 
+  # Player count and sample configuration
   players:
+    # Maximum number of players shown in server list
     max: 20
+    # Current player count shown in server list
     online: 0
+    # Optional list of fake players to display in the server list
     sample:
       - name: Player1
         id: b3a2c344-e57e-43f9-97a6-494d060f0d01
       - name: Player2
         id: c349b9ff-5c76-4831-b06b-d62c14791339
 
+  # Server motd (description)
   motd: "§cFake Minecraft Server"
+
+  # Server icon configuration
+  # Can be either:
+  # 1. Path to a 64x64 PNG file
+  # 2. Base64 data URI starting with "data:image/png;base64,"
   favicon: server-icon.png
 
+# Message shown to players when they try to connect
 kick_message: "§c§lThis is a fake server!\n§eIt only responds to ping requests."