neon_arch commited on
Commit
cfe0ed0
1 Parent(s): 5ebadd1

updating readme.org

Browse files
Files changed (1) hide show
  1. README.org +38 -8
README.org CHANGED
@@ -1,11 +1,16 @@
1
- * Websurfx
2
-
3
- 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.
 
 
 
 
 
 
4
 
5
  * Table of Contents
6
 
7
- - [[#websurfx][Websurfx]]
8
- - [[#table-of-contents][Table of Contents]]
9
  - [[#preview][Preview]]
10
  - [[#main-page][Main Page]]
11
  - [[#search-page][Search Page]]
@@ -22,19 +27,28 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.
22
  - [[#license][License]]
23
  - [[#credits][Credits]]
24
 
 
 
 
 
 
 
 
 
 
25
  * Preview
26
 
27
  ** Main Page
28
 
29
- [[file:images/main_page.png]]
30
 
31
  ** Search Page
32
 
33
- [[file:images/search_page.png]]
34
 
35
  ** 404 Error Page
36
 
37
- [[file:images/404_error_page.png]]
38
 
39
  * Installation and Testing
40
 
@@ -63,6 +77,14 @@ Once you have started the server, open your preferred web browser and navigate t
63
 
64
  *Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use.
65
 
 
 
 
 
 
 
 
 
66
  * More Contributers Wanted
67
 
68
  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:
104
  #+html: <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
105
  #+html: <img src="https://contrib.rocks/image?repo=neon-mmd/websurfx" />
106
  #+html: </a>
 
 
 
 
 
 
 
 
 
1
+ #+html: <h1 align="center">Websurfx</h1>
2
+ #+html: <p align="center">
3
+ #+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>
4
+ #+html: <br/>
5
+ #+html: <br/>
6
+ #+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>
7
+ #+html: <br/><br/>
8
+ #+html: <!---add status badges here---->
9
+ #+html: </p>
10
 
11
  * Table of Contents
12
 
13
+ - [[#features][Features]]
 
14
  - [[#preview][Preview]]
15
  - [[#main-page][Main Page]]
16
  - [[#search-page][Search Page]]
 
27
  - [[#license][License]]
28
  - [[#credits][Credits]]
29
 
30
+ * Features
31
+
32
+ - Proper NSFW blocking
33
+ - 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
34
+ - Advanced image search
35
+ - Fast, private and secure
36
+ - 100% free and open source
37
+ - and lots more...
38
+
39
  * Preview
40
 
41
  ** Main Page
42
 
43
+ #+html: <img align="center" src="./images/main_page.png" />
44
 
45
  ** Search Page
46
 
47
+ #+html: <img align="center" src="./images/search_page.png" />
48
 
49
  ** 404 Error Page
50
 
51
+ #+html: <img align="center" src="./images/404_error_page.png" />
52
 
53
  * Installation and Testing
54
 
 
77
 
78
  *Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use.
79
 
80
+ * Configuration
81
+
82
+ Websurfx is configured throught the config.lua file, located at =websurfx/config.lua=.
83
+
84
+ * Theming
85
+
86
+ 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.
87
+
88
  * More Contributers Wanted
89
 
90
  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.
 
126
  #+html: <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
127
  #+html: <img src="https://contrib.rocks/image?repo=neon-mmd/websurfx" />
128
  #+html: </a>
129
+
130
+ #+html: <p align="center">
131
+ #+html: <a href="https://github.com/neon-mmd/websurfx">
132
+ #+html: <img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
133
+ #+html: </a>
134
+ #+html: <br><br>
135
+ #+html: <i>Thank you for Visiting</i>
136
+ #+html: </p>