Bruhadeesh Siva commited on
Commit
8392a87
β€’
1 Parent(s): fad1fd3

Update README.md

Browse files

Updated grammar, fixed sentence structure, and made a few sentences more engaging. A little bit of work was also done to make the language more confident as well as welcoming to new contributors. Cheers!

Files changed (1) hide show
  1. README.md +14 -14
README.md CHANGED
@@ -1,4 +1,4 @@
1
- <h1 align="center">
2
  <img src="./images/websurfx_logo.png" alt="websurfx logo" align="center" />
3
  </h1>
4
  <p align="center">
@@ -39,7 +39,7 @@
39
  >meta search engine</a
40
  >
41
  (pronounced as websurface or web-surface /wΙ›bˈsɜːrfΙ™s/.) written in Rust. It
42
- provides a quick and secure search experience while maintaining user
43
  privacy.</i
44
  >
45
  </p>
@@ -72,7 +72,7 @@
72
 
73
  # Preview πŸ”­
74
 
75
- ## Main Page
76
 
77
  <img align="center" src="./images/main_page.png" />
78
 
@@ -88,7 +88,7 @@
88
 
89
  # Features πŸš€
90
 
91
- - 🎨 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
92
  - πŸ” Fast, private, and secure
93
  - πŸ†“ 100% free and open source
94
  - πŸ’¨ Ad-free and clean results
@@ -116,7 +116,7 @@ redis-server --port 8082 &
116
  Once you have started the server, open your preferred web browser and navigate to <http://127.0.0.1:8080> to start using Websurfx.
117
 
118
  > **Warning**
119
- > Please be aware that the project is still in the testing phase and is not ready for production use.
120
 
121
  **[⬆️ Back to Top](#--)**
122
 
@@ -132,14 +132,14 @@ Websurfx is configured through the config.lua file, located at `websurfx/config.
132
 
133
  > For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
134
 
135
- 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.
136
 
137
  **[⬆️ Back to Top](#--)**
138
 
139
  # Multi-Language Support 🌍
140
 
141
  > **Note**
142
- > 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.
143
 
144
  **[⬆️ Back to Top](#--)**
145
 
@@ -153,15 +153,15 @@ At present, we only support x86_64 architecture systems, but we would love to ha
153
 
154
  ## Why Websurfx?
155
 
156
- The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused meta-search 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. Also, there is the added problem of Spam, ads, and unorganic results which most engines don't have the full-proof answer to it till now but with Websurfx I finally put a full stop to this problem, also, 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 and Micro-apps or Quick results (like providing a calculator, currency exchanges, etc in the search results).
157
 
158
  ## Why AGPLv3?
159
 
160
- 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.
161
 
162
  ## Why Rust?
163
 
164
- 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.
165
 
166
  **[⬆️ Back to Top](#--)**
167
 
@@ -175,14 +175,14 @@ We are looking for more willing contributors to help grow this project. For more
175
 
176
  > For full details and other ways you can help out, see: [**Contributing**]()
177
 
178
- 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.
179
 
180
  Several areas that we need a bit of help with at the moment are:
181
  - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
182
  - **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
183
  - **Logo** - Help create a logo for the project and website.
184
  - **Docker Support** - Help write a Docker Compose file for the project.
185
- - Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or something else.
186
  - Star Websurfx on GitHub.
187
 
188
  **[⬆️ Back to Top](#--)**
@@ -196,13 +196,13 @@ Several areas that we need a bit of help with at the moment are:
196
 
197
  # Roadmap πŸ›£οΈ
198
 
199
- > Coming soon!! πŸ™‚.
200
 
201
  **[⬆️ Back to Top](#--)**
202
 
203
  # Contributing πŸ™‹
204
 
205
- Contributions are welcome from anyone. It doesn\'t matter who you are; you can still contribute to the project in your own way.
206
 
207
  ## Not a developer but still want to contribute?
208
 
 
1
+ ο»Ώ<h1 align="center">
2
  <img src="./images/websurfx_logo.png" alt="websurfx logo" align="center" />
3
  </h1>
4
  <p align="center">
 
39
  >meta search engine</a
40
  >
41
  (pronounced as websurface or web-surface /wΙ›bˈsɜːrfΙ™s/.) written in Rust. It
42
+ provides a quick and secure search experience while completely respecting user
43
  privacy.</i
44
  >
45
  </p>
 
72
 
73
  # Preview πŸ”­
74
 
75
+ ## Home Page
76
 
77
  <img align="center" src="./images/main_page.png" />
78
 
 
88
 
89
  # Features πŸš€
90
 
91
+ - 🎨 Make Websurfx uniquely yours with nine color schemes provided by default. It also supports creation of custom themes and color schemes in a quick and easy way, so unleash your creativity!
92
  - πŸ” Fast, private, and secure
93
  - πŸ†“ 100% free and open source
94
  - πŸ’¨ Ad-free and clean results
 
116
  Once you have started the server, open your preferred web browser and navigate to <http://127.0.0.1:8080> to start using Websurfx.
117
 
118
  > **Warning**
119
+ > This project is still in the testing phase and is **not** ready for production use.
120
 
121
  **[⬆️ Back to Top](#--)**
122
 
 
132
 
133
  > For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
134
 
135
+ Websurfx comes loaded with several themes and color schemes, which you can apply and edit through the config file. It also supports custom themes and color schemes using CSS, allowing you to make it truly yours.
136
 
137
  **[⬆️ Back to Top](#--)**
138
 
139
  # Multi-Language Support 🌍
140
 
141
  > **Note**
142
+ > Currently, we do not support other languages but we will start accepting contributions regarding language support in the future. We believe language should never be a barrier to entry.
143
 
144
  **[⬆️ Back to Top](#--)**
145
 
 
153
 
154
  ## Why Websurfx?
155
 
156
+ The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused meta-search engine. There are numerous meta-search engines available, but not all 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 understandably bad. There is also the added problem of spam, ads, and inorganic results which most engines don't have a fool-proof answer to. Until now. With Websurfx I finally put a full stop to this problem. Websurfx is based on Rust, which ensures memory safety and removes such issues. Many meta-search engines also lack important features like advanced picture search, required by graphic designers, content providers, and others. Websurfx improves the user experience by providing these and other features, such as proper NSFW blocking and Micro-apps or Quick Results (providing a calculator, currency exchanges, etc in the search results).
157
 
158
  ## Why AGPLv3?
159
 
160
+ Websurfx is distributed under the **AGPLv3** license to keep the source code open and transparent. This helps keep malware, telemetry, and other dangers 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.
161
 
162
  ## Why Rust?
163
 
164
+ Websurfx is based on Rust due to its memory safety features, which prevents vulnerabilities and makes the codebase more secure. Rust is also faster than C++, contributing to Websurfx's speed and responsiveness. Finally, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
165
 
166
  **[⬆️ Back to Top](#--)**
167
 
 
175
 
176
  > For full details and other ways you can help out, see: [**Contributing**]()
177
 
178
+ If you use Websurfx and would like to contribute to its development, we're glad to have you on board! Contributions of any size or type are always welcome, and we will always acknowledge your efforts.
179
 
180
  Several areas that we need a bit of help with at the moment are:
181
  - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
182
  - **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
183
  - **Logo** - Help create a logo for the project and website.
184
  - **Docker Support** - Help write a Docker Compose file for the project.
185
+ - Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or anything else.
186
  - Star Websurfx on GitHub.
187
 
188
  **[⬆️ Back to Top](#--)**
 
196
 
197
  # Roadmap πŸ›£οΈ
198
 
199
+ > Coming soon! πŸ™‚.
200
 
201
  **[⬆️ Back to Top](#--)**
202
 
203
  # Contributing πŸ™‹
204
 
205
+ Contributions are welcome from anyone. It doesn't matter who you are; you can still contribute to the project in your own way.
206
 
207
  ## Not a developer but still want to contribute?
208