Improve docs

cezarmathe · Jun 20, 2021 · dc30902 · dc30902
1 parent 0e9ad09
commit dc30902
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git 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
diff --git 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 → sample.env b/.sample.env → sample.env