alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-12-22 04:18:21 -05:00
Code Issues Releases Activity

updating readme.org

Browse Source
This commit is contained in:
neon_arch 2023-05-04 20:33:03 +03:00
parent 5ebadd1f2e
commit cfe0ed0ace
1 changed files with 38 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.org
View File

@ -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: <h1 align="center">Websurfx</h1>
#+html: <p align="center">
#+html: <i> A lightning-fast, privacy-respecting, secure <a href="https://en.wikipedia.org/wiki/Metasearch_engine">meta search engine</a> (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.</i>
#+html: <br/>
#+html: <br/>
#+html: <b align="center"><a href="README.org">Readme</a></b> | <b><a href="https://discord.gg/k4GH2TnZ">Discord</a></b> | <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b>
#+html: <br/><br/>
#+html: <!---add status badges here---->
#+html: </p>
* 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: <img align="center" src="./images/main_page.png" />
** Search Page
[[file:images/search_page.png]]
#+html: <img align="center" src="./images/search_page.png" />
** 404 Error Page
[[file:images/404_error_page.png]]
#+html: <img align="center" src="./images/404_error_page.png" />
* 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: <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
#+html: <img src="https://contrib.rocks/image?repo=neon-mmd/websurfx" />
#+html: </a>
#+html: <p align="center">
#+html: <a href="https://github.com/neon-mmd/websurfx">
#+html: <img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
#+html: </a>
#+html: <br><br>
#+html: <i>Thank you for Visiting</i>
#+html: </p>