From c0f4f7563cab21d023df02b4fb7e88e33663eba9 Mon Sep 17 00:00:00 2001
From: hnhx <49120638+hnhx@users.noreply.github.com>
Date: Thu, 17 Feb 2022 21:56:04 +0100
Subject: [PATCH] Update README.md
---
README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 47 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index fd0dd16..5164fbb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,47 @@
-# librex
+LibreX
+
+ 
+ 
+
+
+
+A privacy respecting free as in freedom meta search engine for Google
+
+# Online instances
+todo
+
+# Features
++ Ad free
++ JavaScript free
++ Tracking snippets from URLs are removed
++ Image results are converted to base64 to prevent clients from connecting to Google servers
++ Supports both POST and GET requests
++ Easy to use JSON API
++ No 3rd party libs are used
++ Easy to setup
+
+# Hosting
+Hosting LibreX should be easy since no 3rd party libs are used.
+All you need is a webserver (e.g.: nginx) and PHP, and you are good to go.
+
+# API
+Example API request: `.../api.php?q=gentoo&p=2&img_search=false`
+Where `q` is the keyword and `p` is the result page (the first page is `p=0`)
+
+JSON result:
++ In case of text search:
+ + `title`: Title of the result site
+ + `url`: Full URL of the result
+ + `base_url`: The base URL of the result (e.g.: http://example.com/test.php -> http://example.com/)
++ In case of image search:
+ + `base64`: The result image converted to base64 format
+ + `alt`: The description of the image
+
+
+The API also supports both GET and POST requests
+
+# To do
++ Improve the quality of the CSS
++ Add more settings to config.php
++ Add special search features (e.g.: 10 usd to euro)
++ Add video results