MD AL AMIN TALUKDAR commited on
Commit
69f4424
β€’
2 Parent(s): 84dc6a9 6a4935a

Merge pull request #2 from alamin655/readme.md

Browse files
Files changed (1) hide show
  1. README.md +26 -26
README.md CHANGED
@@ -1,6 +1,6 @@
1
  <h1 align="center">Websurfx</h1>
2
  <p align="center">
3
- <b align="center"><a href="README.org">Readme</a></b> |
4
  <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
5
  <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
6
  <b><a href="https://github.com/neon-mmd/websurfx/wiki">Documentation</a></b>
@@ -73,7 +73,7 @@
73
  >meta search engine</a
74
  >
75
  (pronounced as websurface or web-surface /wΙ›bˈsɜːrfΙ™s/.) written in Rust. It
76
- provides a fast and secure search experience while respecting user
77
  privacy.</i
78
  >
79
  </p>
@@ -84,7 +84,7 @@
84
 
85
  - **Getting Started**
86
  - [πŸ”­ Preview](#preview-)
87
- - [🌈 Features](#features-)
88
  - [πŸ› οΈ Installation and Testing](#installation-and-testing-)
89
  - [πŸ”§ Configuration](#configuration-)
90
  - **Feature Overview**
@@ -120,13 +120,13 @@
120
 
121
  **[⬆️ Back to Top](#websurfx)**
122
 
123
- # Features 🌈
124
 
125
- - 🎨 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
126
- - πŸ” Fast, private and secure
127
  - πŸ†“ 100% free and open source
128
- - 🧹 Ad free and clean results
129
- - 🌈 and lots more...
130
 
131
  **[⬆️ Back to Top](#websurfx)**
132
 
@@ -134,13 +134,13 @@
134
 
135
  > For full setup instructions, see: [**Installation**](https://github.com/neon-mmd/websurfx/wiki/installation)
136
 
137
- To get started with Websurfx, clone the repository, edit the config file which is located in the `websurfx`{.verbatim} directory and install redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands:
138
 
139
  ``` shell
140
  git clone https://github.com/neon-mmd/websurfx.git
141
  cd websurfx
142
  cargo build
143
- redis-server -p 8082 &
144
  ./target/debug/websurfx
145
  ```
146
 
@@ -163,20 +163,20 @@ Websurfx is configured through the config.lua file, located at `websurfx/config.
163
 
164
  > For full theming and customization instructions, see: [**Theming**](https://github.com/neon-mmd/websurfx/wiki/theming)
165
 
166
- 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.
167
 
168
  **[⬆️ Back to Top](#websurfx)**
169
 
170
  # Multi-Language Support 🌍
171
 
172
  > **Note**
173
- > Currently, we do not support other languages but in future we would start accepting contributions regarding language support because we believe that language should not be a barrier for entry.
174
 
175
  **[⬆️ Back to Top](#websurfx)**
176
 
177
  # System Requirements πŸ“Š
178
 
179
- At present, we only support x86_64 architecture systems but will love to have contributions to extend to other architectures as well.
180
 
181
  **[⬆️ Back to Top](#websurfx)**
182
 
@@ -184,21 +184,21 @@ At present, we only support x86_64 architecture systems but will love to have co
184
 
185
  ## Why Websurfx?
186
 
187
- The main goal of the Websurfx project is to provide a fast, secure, and privacy-focused [meta search engine](https://en.wikipedia.org/wiki/Metasearch_engine). While there are many meta search engines available, they do not always guarantee the security of their search engine, which is essential for ensuring privacy. For example, memory vulnerabilities can leak private or sensitive information, which is never good. Websurfx is written in Rust, which guarantees memory safety and eliminates such problems. Many meta search engines also lack key features such as advanced image search, which is required by many graphic designers, content creators, and others. Websurfx aims to provide these features and others, such as proper NSFW blocking, to improve the user experience.
188
 
189
  ## Why AGPLv3?
190
 
191
- Websurfx is released under the **AGPLv3** license to ensure that the source code remains open and transparent. This helps to prevent the inclusion of spyware, telemetry, or other malicious code in the project. **AGPLv3** is a strong copyleft license that ensures the source code of the software remains open and available to everyone, including any modifications or improvements made to the code.
192
 
193
  ## Why Rust?
194
 
195
- Rust was chosen as the programming language for Websurfx due to its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which helps to make Websurfx fast and responsive. In addition, Rust\'s ownership and borrowing system allows for safe concurrency and thread safety in the codebase.
196
 
197
  **[⬆️ Back to Top](#websurfx)**
198
 
199
  # More Contributers Wanted πŸ“£
200
 
201
- We are looking for more willing contributors to help grow this project.For more information on how you can contribute, check out the [project board](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.org](CONTRIBUTING.org) file for guidelines and rules for making contributions.
202
 
203
  **[⬆️ Back to Top](#websurfx)**
204
 
@@ -206,14 +206,14 @@ We are looking for more willing contributors to help grow this project.For more
206
 
207
  > For full details and other ways you can help out, see: [**Contributing**]()
208
 
209
- If you're using Websurfx and would like to help support its development, then that would be awesome! Contributions of any type, any size, are always very much appreciated, and we will appropriately credit you for your effort.
210
 
211
  Several areas that we need a bit of help with at the moment are:
212
- - **Better and more colorchemes** - Help fix colorchemes and add other famous colorchemes.
213
- - **Improve evasion code for bot detection** - Help improve code related to evade ip blocking and emulate human behaviours located in everyone engine file.
214
  - **Logo** - Help create a logo for the project and website.
215
- - **Docker Support** - Help write a docker compose file for the project.
216
- - Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget or something else.
217
  - Star Websurfx on GitHub.
218
 
219
  **[⬆️ Back to Top](#websurfx)**
@@ -221,7 +221,7 @@ Several areas that we need a bit of help with at the moment are:
221
  # Documentation πŸ“˜
222
 
223
  > **Note**
224
- > We are willing to have any contribution regarding [documentation](https://github.com/neon-mmd/websurfx/wiki) as this helps everyone using this project.
225
 
226
  **[⬆️ Back to Top](#websurfx)**
227
 
@@ -233,7 +233,7 @@ Several areas that we need a bit of help with at the moment are:
233
 
234
  # Contributing πŸ™‹
235
 
236
- Contributions are welcome from anyone. It doesn\'t matter who you are; you can still contribute to the project in your way.
237
 
238
  ## Not a developer but still want to contribute?
239
 
@@ -241,13 +241,13 @@ Check out this [video](https://youtu.be/FccdqCucVSI) by Mr. Nick on how to contr
241
 
242
  ## Developer
243
 
244
- If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.org) document for more information.
245
 
246
  **[⬆️ Back to Top](#websurfx)**
247
 
248
  # License πŸ“œ
249
 
250
- Websurfx is available under the [AGPLv3](LICENSE) license.
251
 
252
  **[⬆️ Back to Top](#websurfx)**
253
 
 
1
  <h1 align="center">Websurfx</h1>
2
  <p align="center">
3
+ <b align="center"><a href="README.md">Readme</a></b> |
4
  <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
5
  <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
6
  <b><a href="https://github.com/neon-mmd/websurfx/wiki">Documentation</a></b>
 
73
  >meta search engine</a
74
  >
75
  (pronounced as websurface or web-surface /wΙ›bˈsɜːrfΙ™s/.) written in Rust. It
76
+ provides a quick and secure search experience while maintaining user
77
  privacy.</i
78
  >
79
  </p>
 
84
 
85
  - **Getting Started**
86
  - [πŸ”­ Preview](#preview-)
87
+ - [πŸš€ Features](#features-)
88
  - [πŸ› οΈ Installation and Testing](#installation-and-testing-)
89
  - [πŸ”§ Configuration](#configuration-)
90
  - **Feature Overview**
 
120
 
121
  **[⬆️ Back to Top](#websurfx)**
122
 
123
+ # Features πŸš€
124
 
125
+ - 🎨 High level of customizability with nine color schemes provided by default with a simple theme, also supporting the creation of your custom themes and colorschemes very quickly and easily
126
+ - πŸ” Fast, private, and secure
127
  - πŸ†“ 100% free and open source
128
+ - πŸ’¨ Ad-free and clean results
129
+ - 🌟 and lots more...
130
 
131
  **[⬆️ Back to Top](#websurfx)**
132
 
 
134
 
135
  > For full setup instructions, see: [**Installation**](https://github.com/neon-mmd/websurfx/wiki/installation)
136
 
137
+ To get started with Websurfx, clone the repository, edit the config file, which is located in the `websurfx`{.verbatim} directory, and install the Redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands:
138
 
139
  ``` shell
140
  git clone https://github.com/neon-mmd/websurfx.git
141
  cd websurfx
142
  cargo build
143
+ redis-server --port 8082 &
144
  ./target/debug/websurfx
145
  ```
146
 
 
163
 
164
  > For full theming and customization instructions, see: [**Theming**](https://github.com/neon-mmd/websurfx/wiki/theming)
165
 
166
+ Websurfx comes with several themes and color schemes by default, which you can apply and edit through the config file. Supports custom themes and color schemes using CSS, allowing you to develop your own unique-looking website.
167
 
168
  **[⬆️ Back to Top](#websurfx)**
169
 
170
  # Multi-Language Support 🌍
171
 
172
  > **Note**
173
+ > Currently, we do not support other languages, but in the future, we will start accepting contributions regarding language support because we believe that language should not be a barrier to entry.
174
 
175
  **[⬆️ Back to Top](#websurfx)**
176
 
177
  # System Requirements πŸ“Š
178
 
179
+ At present, we only support x86_64 architecture systems, but we would love to have contributions that extend to other architectures as well.
180
 
181
  **[⬆️ Back to Top](#websurfx)**
182
 
 
184
 
185
  ## Why Websurfx?
186
 
187
+ The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused [meta search engine](https://en.wikipedia.org/wiki/Metasearch_engine). While there are numerous meta search engines available, not all of them guarantee the security of their search engine, which is critical for maintaining privacy. Memory flaws, for example, can expose private or sensitive information, which is never a good thing. Rust is used to write Websurfx, which ensures memory safety and removes such issues. Many meta search engines also lack important features like advanced picture search, which is required by many graphic designers, content providers, and others. Websurfx attempts to improve the user experience by providing these and other features, such as proper NSFW blocking.
188
 
189
  ## Why AGPLv3?
190
 
191
+ Websurfx is distributed under the **AGPLv3** license to keep the source code open and transparent. This helps to keep malware, telemetry, and other dangerous programs out of the project. **AGPLv3** is a strong copyleft license that ensures the software's source code, including any modifications or improvements made to the code, remains open and available to everyone.
192
 
193
  ## Why Rust?
194
 
195
+ Rust was chosen as the programming language for Websurfx because of its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which contributes to Websurfx's speed and responsiveness. Furthermore, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
196
 
197
  **[⬆️ Back to Top](#websurfx)**
198
 
199
  # More Contributers Wanted πŸ“£
200
 
201
+ We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [project board](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines and rules for making contributions.
202
 
203
  **[⬆️ Back to Top](#websurfx)**
204
 
 
206
 
207
  > For full details and other ways you can help out, see: [**Contributing**]()
208
 
209
+ If you use Websurfx and would like to contribute to its development, that would be fantastic! Contributions of any size or type are always welcome, and we will properly acknowledge your efforts.
210
 
211
  Several areas that we need a bit of help with at the moment are:
212
+ - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
213
+ - **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
214
  - **Logo** - Help create a logo for the project and website.
215
+ - **Docker Support** - Help write a Docker Compose file for the project.
216
+ - Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or something else.
217
  - Star Websurfx on GitHub.
218
 
219
  **[⬆️ Back to Top](#websurfx)**
 
221
  # Documentation πŸ“˜
222
 
223
  > **Note**
224
+ > We welcome any contributions to the [documentation](https://github.com/neon-mmd/websurfx/wiki) as this will benefit everyone who uses this project.
225
 
226
  **[⬆️ Back to Top](#websurfx)**
227
 
 
233
 
234
  # Contributing πŸ™‹
235
 
236
+ Contributions are welcome from anyone. It doesn\'t matter who you are; you can still contribute to the project in your own way.
237
 
238
  ## Not a developer but still want to contribute?
239
 
 
241
 
242
  ## Developer
243
 
244
+ If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) document for more information.
245
 
246
  **[⬆️ Back to Top](#websurfx)**
247
 
248
  # License πŸ“œ
249
 
250
+ Websurfx is licensed under the [AGPLv3](LICENSE) license.
251
 
252
  **[⬆️ Back to Top](#websurfx)**
253