From 5f9e04b8667b99fa68c5ba5eae9635ce25a8de90 Mon Sep 17 00:00:00 2001
From: Luna Mendes <luna@elixi.re>
Date: Thu, 15 Nov 2018 18:08:12 -0300
Subject: [PATCH] README: add "Checking if it is working" section

Related to #18.
---
 README.md  | 9 +++++++++
 nginx.conf | 8 ++++++--
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2b137d7..8b981ae 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,15 @@ Use `--access-log -` to output access logs to stdout.
 $ pipenv run hypercorn run:app
 ```
 
+*It is recommended to run litecord behind NGINX.* Because of that,
+there is a basic `nginx.conf` file at the root.
+
+### Checking if it is working
+
+You can check if your instance is running by checking the `/api/v6/gateway`
+path. And for basic websocket testing a tool such as [wss](https://github.com/hashrocket/ws)
+can be used.
+
 ## Updating
 
 ```sh
diff --git a/nginx.conf b/nginx.conf
index d42d2df..b29c560 100644
--- a/nginx.conf
+++ b/nginx.conf
@@ -1,6 +1,10 @@
-# Main litecord HTTP proxy.
+# litecord nginx file
+
+# this file is not considering any https happening,
+# those are manual and up to the instance owner.
+
 server {
-    server_name main.somewhere;
+    server_name example.tld;
 
     location / {
         proxy_pass http://localhost:5000;