From cfe0ed0aceba26574143e7e51d9b2016d4cf2b80 Mon Sep 17 00:00:00 2001 From: neon_arch Date: Thu, 4 May 2023 20:33:03 +0300 Subject: [PATCH] updating readme.org --- README.org | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.org b/README.org index 0f160e7..f13a9f1 100644 --- a/README.org +++ b/README.org @@ -1,11 +1,16 @@ -* Websurfx - -Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.org/wiki/Metasearch_engine][meta search engine]] (pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It provides a fast and secure search experience while respecting user privacy. +#+html:

Websurfx

+#+html:

+#+html: A lightning-fast, privacy-respecting, secure meta search engine (pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It provides a fast and secure search experience while respecting user privacy. +#+html:
+#+html:
+#+html: Readme | Discord | GitHub +#+html:

+#+html: +#+html:

* Table of Contents -- [[#websurfx][Websurfx]] -- [[#table-of-contents][Table of Contents]] +- [[#features][Features]] - [[#preview][Preview]] - [[#main-page][Main Page]] - [[#search-page][Search Page]] @@ -22,19 +27,28 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia. - [[#license][License]] - [[#credits][Credits]] +* Features + +- Proper NSFW blocking +- High level customizability with 9 colorchemes provided by default with a simple theme, also supporting creation of your custom themes and colorschemes very quickly and easily +- Advanced image search +- Fast, private and secure +- 100% free and open source +- and lots more... + * Preview ** Main Page -[[file:images/main_page.png]] +#+html: ** Search Page -[[file:images/search_page.png]] +#+html: ** 404 Error Page -[[file:images/404_error_page.png]] +#+html: * Installation and Testing @@ -63,6 +77,14 @@ Once you have started the server, open your preferred web browser and navigate t *Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use. +* Configuration + +Websurfx is configured throught the config.lua file, located at =websurfx/config.lua=. + +* Theming + +Websurfx comes with several themes and colorschemes by default which you can apply and edit through the config file. Support for custom themes and colorschemes using css and develop your own unique-looking website. + * More Contributers Wanted We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [[https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen][project board]] and the [[file:CONTRIBUTING.org][CONTRIBUTING.org]] file for guidelines and rules for making contributions. @@ -104,3 +126,11 @@ We would like to thank the following people for their contributions and support: #+html: #+html: #+html: + +#+html:

+#+html: +#+html: +#+html: +#+html:

+#+html: Thank you for Visiting +#+html: