From faca4b8fe3d355846f187c2515a341e26142f13e Mon Sep 17 00:00:00 2001
From: yakamok <38737288+yakamok@users.noreply.github.com>
Date: Wed, 21 Nov 2018 18:27:06 +0100
Subject: [PATCH] edit

---
 api/README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/api/README.md b/api/README.md
index 421497d..3674228 100644
--- a/api/README.md
+++ b/api/README.md
@@ -1,6 +1,6 @@
 # niflheim-api.py
 
-This api provides a web interface to see some basic stats on the data vserv.py has collected and also provides an easy way to get the data through the api.  
+Niflheim-api provides both a web interface and an api. The web interface is used to see some basic stats on the data vserv.py has collected and the API provides raw data in JSON format.  
 
 ## Install & Setup
 
@@ -18,3 +18,8 @@ Make sure the above matches what you have in vserv.py.
 The API will startup on port 3000 and accept all ipv6 connections if you want to change this edit the last line:  
 
     app.run(host='::', port=3000)
+
+__Accessing the API dat:__  
+
+    http://exmaple.com:3000/current  
+