From 5ea5f71091082aa8422e0565278379d387d6eed1 Mon Sep 17 00:00:00 2001
From: xmrig <support@xmrig.com>
Date: Fri, 6 Oct 2017 16:58:32 +0300
Subject: [PATCH] Created API (markdown)

---
 API.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..295b74a
--- /dev/null
+++ b/API.md
@@ -0,0 +1,11 @@
+In version **2.4.0** added HTTP API. If you build miner from source, **libmicrohttpd** dependency added. If you want use API you need choice a port where is internal HTTP server will listen for incoming connections.
+
+Example configuration:
+```json
+"api": {
+    "port": 8080,
+    "access-token": "Optional Bearer Token used for authorization",
+    "worker-id": "Optional miner name"
+}
+```
+If you prefer use command line options instead of config file, you can use options: `--api-port`, `--api-access-token` and `--api-worker-id`.
\ No newline at end of file