From e9e7a4cb4bdf0a1fe0356d465f8becac49b46320 Mon Sep 17 00:00:00 2001
From: Alex Auvolat <alex@adnab.me>
Date: Sun, 2 Feb 2020 12:34:52 +0100
Subject: [PATCH] Update README with accurate info on how to build Bottin

---
 README.md | 9 ++++++++-
 TODO.md   | 6 ++++++
 main.go   | 3 ---
 3 files changed, 14 insertions(+), 4 deletions(-)
 create mode 100644 TODO.md

diff --git a/README.md b/README.md
index a50f167..48c988c 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,6 @@ Features:
 - Access control through an ACL (hardcoded in the configuration file)
 
 
-Building Bottin can be done simply by running `go build` in this folder.
 A Docker image is provided on the [Docker hub](https://hub.docker.com/r/lxpz/bottin_amd64).
 An example for running Bottin on a Nomad cluster can be found in `bottin.hcl.example`.
 
@@ -26,6 +25,14 @@ The configuration file is a JSON file whose contents is described in the followi
 Bottin is licensed under the terms of the GPLv3.
 
 
+## Building Bottin
+
+Bottin requires go 1.13 or later.
+
+To build Bottin, clone this repository outside of your `$GOPATH`.
+Then, run `make` in the root of the repo.
+
+
 ## Server initialization
 
 When Bottin is launched on an empty database,
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..d9fcafa
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,6 @@
+- Switch to `go mod` for building Bottin
+
+- Implement missing search filters (in applyFilter)
+- Add an initial prefix to the consul key value
+
+- Potential bugs with different combinations of lower/uppercase names
diff --git a/main.go b/main.go
index f9aef52..58fa466 100644
--- a/main.go
+++ b/main.go
@@ -1,8 +1,5 @@
 package main
 
-// @FIXME: Proper handling of various upper/lower case combinations
-// @FIXME: Implement missing search filters (in applyFilter)
-// @FIXME: Add an initial prefix to the consul key value
 
 import (
 	"crypto/rand"