Fijxu
/
librex
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
hnhx 2022-02-20 23:06:07 +01:00 committed by GitHub
parent d33f027606
commit 11d68fb57a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,7 +1,8 @@
<h1 align="center">LibreX</h1>
<p align="center">
<img src="https://user-images.githubusercontent.com/49120638/154568117-7c018962-fa93-4c7b-8544-897ee82846af.png" width=500>
<img src="https://user-images.githubusercontent.com/49120638/154569127-9281bf13-567f-43fd-9ec2-0d691931b9d0.png" width=500>
<img src="https://user-images.githubusercontent.com/49120638/154866133-b55bfd49-41bf-4cd7-8060-aafafb06f40a.png" width=500>
<img src="https://user-images.githubusercontent.com/49120638/154866199-e68719a8-8013-4367-86c3-f89c2d9b556d.png" width=500>
</p>
@ -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.<br/>
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` <br/>
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` <br/>
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)
<br/><br/>
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/)
<br/>
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