From dc30902a71896852bb660984fe29218fe1461aba Mon Sep 17 00:00:00 2001
From: Armand-Cezar Mathe <me@cezarmathe.com>
Date: Sun, 20 Jun 2021 13:01:16 +0300
Subject: [PATCH] Improve docs

---
 README.md                                         | 8 +++++---
 docs/deploy_a_docker_container_using_terraform.md | 1 -
 docs/run_the_binary.md                            | 2 +-
 .sample.env => sample.env                         | 0
 4 files changed, 6 insertions(+), 5 deletions(-)
 delete mode 100644 docs/deploy_a_docker_container_using_terraform.md
 rename .sample.env => sample.env (100%)

diff --git a/README.md b/README.md
index 01dd3de..db60b60 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
 # stevebot
 
-**THIS README IS A WORK IN PROGRESS !!!**
-
 Control your Minecraft server via RCON, right from your Discord server.
 
 ## What does this do?
@@ -15,7 +13,11 @@ There are three ways to run **stevebot**.
 
 1. [Run the binary](docs/run_the_binary.md)
 2. [Deploy a Docker container yourself](docs/deploy_a_docker_container_yourself.md)
-3. [Use Terraform to deploy a Docker container](docs/deploy_a_docker_container_using_terraform.md)
+3. [Use Terraform to deploy a Docker container](https://registry.terraform.io/modules/cezarmathe/stevebot/docker/latest)
+
+## Configuration
+
+**stevebot** uses environment variables for configuration - check out [sample.env](sample.env).
 
 ## Releases
 
diff --git a/docs/deploy_a_docker_container_using_terraform.md b/docs/deploy_a_docker_container_using_terraform.md
deleted file mode 100644
index 3556bb5..0000000
--- a/docs/deploy_a_docker_container_using_terraform.md
+++ /dev/null
@@ -1 +0,0 @@
-# Deploy a Docker container using Terraform
diff --git a/docs/run_the_binary.md b/docs/run_the_binary.md
index 50c92c7..bd16dd3 100644
--- a/docs/run_the_binary.md
+++ b/docs/run_the_binary.md
@@ -29,7 +29,7 @@ and the architecture for your os (`amd64` or `arm64`).
 
 `tar xvf stevebot-${version}-${os}-${arch}.tar.gz`
 
-- Create a `.env` file (see the [sample](../.sample.env))
+- Create a `.env` file (see the [sample](../sample.env))
 
 - Run the binary
 
diff --git a/.sample.env b/sample.env
similarity index 100%
rename from .sample.env
rename to sample.env