From 11d68fb57a8ece0f8196566cddeb7e8dc51cdd21 Mon Sep 17 00:00:00 2001 From: hnhx <49120638+hnhx@users.noreply.github.com> Date: Sun, 20 Feb 2022 23:06:07 +0100 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4f5248c..2724ef4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@

LibreX

+

- - + +

@@ -22,9 +23,11 @@ Your request will be **rejected** if your instance: # Features + Ad free + JavaScript free ++ Cookie 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 ++ YouTube results are converted into a privacy friendly Invidious instance + Easy to use JSON API + No 3rd party libs are used + Easy to setup @@ -34,8 +37,8 @@ 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`) +Example API request: `.../api.php?q=gentoo&p=2&type=0`
+Where `q` is the keyword, `p` is the result page (the first page is `0`) and `type` is the search type (`0`=text, `1`=image, `2`=video)

JSON result: + In case of text search: @@ -45,14 +48,13 @@ JSON result: + In case of image search: + `base64`: The result image converted to base64 format + `alt`: The description of the image ++ In case of video search: + + `title`: Title of the result video + + `url`: Full URL of the video + + `base_url`: The base URL of the result (e.g.: http://youtube.com/watch -> http://youtube.com/)
The API also supports both GET and POST requests # Donate Monero (XMR): `41dGQr9EwZBfYBY3fibTtJZYfssfRuzJZDSVDeneoVcgckehK3BiLxAV4FvEVJiVqdiW996zvMxhFB8G8ot9nBFqQ84VkuC` - -# To do -+ Improve the quality of the CSS -+ Add more settings to config.php -+ Add video results