From 013139b036e31043e25991112a34588011650243 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?No=C3=A9mi=20V=C3=A1nyi?= <sitbackandwait@gmail.com>
Date: Tue, 6 Sep 2016 18:16:29 +0200
Subject: [PATCH] add embedded search to docs

---
 docs/admin/api.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/admin/api.rst b/docs/admin/api.rst
index 94508a28..8d616224 100644
--- a/docs/admin/api.rst
+++ b/docs/admin/api.rst
@@ -76,3 +76,19 @@ Sample response
       ], 
       "safe_search": 0
     }
+
+Embed search bar
+----------------
+
+The search bar can be embedded into websites. Just paste the example into the HTML of the site.
+URL of the searx instance and values are customizable.
+
+.. code:: html
+    
+    <form method="post" action="https://searx.me/">
+        <!-- search query --> <input type="text" name="q" />
+        <!-- categories   --> <input type="hidden" name="categories" value="general,social media" />
+        <!-- language     --> <input type="hidden" name="lang" value="all" />
+        <!-- locale       --> <input type="hidden" name="locale" value="en" />
+        <!-- date filter  --> <input type="hidden" name="time_range" value="month" />
+    </form>