From 712168f38d2baba7c10d8d051dab066e09275d25 Mon Sep 17 00:00:00 2001
From: Oliver Gugger <gugger@gmail.com>
Date: Fri, 10 Jan 2020 11:06:05 +0100
Subject: [PATCH] doc: update installation instructions

---
 INSTALL.md |  9 ---------
 README.md  | 24 ++++++++++++++++++++++--
 2 files changed, 22 insertions(+), 11 deletions(-)
 delete mode 100644 INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index ea82c0a..0000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,9 +0,0 @@
-## Requirements
-
-* go 1.13
-
-## Up and Running
-1. Clone the repository.
-2. See `sample-conf.yaml` to see how to configure your target backend services (and, optionally, change the port that Kirin runs on).
-3. `cd cmd/kirin && go build` 
-4. `./kirin`
diff --git a/README.md b/README.md
index 509e53c..c19239f 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,29 @@
 Kirin is a HTTP reverse proxy that supports proxying requests for gRPC (HTTP/2)
 and REST (HTTP/1 and HTTP/2) backends.
 
-## Installation
+## Installation / Setup
 
-See [INSTALL.md](install.md).
+**lnd**
+
+* Make sure lnd ports are reachable.
+
+**kirin**
+
+* Compilation requires go `1.13.x` or later.
+* Build `kirin`:  
+  `make build`
+* Copy the binary `./kirin` to the server.
+* Make sure port `8081` is reachable from outside (or whatever port we choose,
+  could also be 443 at some point)
+* Make sure there is a valid `tls.cert` and `tls.key` file located in the
+  `~/.kirin` directory that is valid for the domain that kirin is running on.
+  Kirin doesn't support creating its own certificate through Let's Encrypt yet.
+  If there is no `tls.cert` and `tls.key` found, a self-signed pair will be
+  created.
+* Make sure all required configuration items are set in `~/.kirin/kirin.yaml`,
+  compare with `sample-conf.yaml`.
+* Start kirin without any command line parameters (`./kirin`), all configuration
+  is done in the `~/.kirin/kirin.yaml` file.
 
 ## Demo