📝 Revise the readme for making general improvements (#341)

* Update README.md

* bump websurfx version to 1.2.3

* bump websurfx version to 1.2.3

Cargo.lock

@@ -4042,7 +4042,7 @@ checksum = "14247bb57be4f377dfb94c72830b8ce8fc6beac03cf4bf7b9732eadd414123fc"
 
 [[package]]
 name = "websurfx"
-version = "1.2.1"
+version = "1.2.3"
 dependencies = [
  "actix-cors",
  "actix-files",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "websurfx"
-version = "1.2.1"
+version = "1.2.3"
 edition = "2021"
 description = "An open-source alternative to Searx that provides clean, ad-free, and organic results with incredible speed while keeping privacy and security in mind."
 repository = "https://github.com/neon-mmd/websurfx"

README.md

@@ -4,10 +4,10 @@
 <p align="center">
   <b align="center"><a href="README.md">Readme</a></b> |
   <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
-  <b><a href="../../tree/HEAD/docs/instances.md">Instances</a></b> |
+  <b><a href="docs/instances.md">Instances</a></b> |
   <b><a href="https://discord.gg/VKCAememnr">User Showcase</a></b> |
   <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
-  <b><a href="../../tree/HEAD/docs/">Documentation</a></b>
+  <b><a href="docs">Documentation</a></b>
   <br /><br />
    <a
       href="https://github.com/awesome-selfhosted/awesome-selfhosted#search-engines"
@@ -67,7 +67,7 @@
 - **Getting Started**
   - [🔭 Preview](#preview-)
   - [🚀 Features](#features-)
-  - [🔗 Instances](instances-)
+  - [🔗 Instances](#instances-)
   - [🛠️ Installation and Testing](#installation-and-testing-%EF%B8%8F)
   - [🔧 Configuration](#configuration-)
 - **Feature Overview**
@@ -75,11 +75,11 @@
   - [🌍 Multi-Language Support](#multi-language-support-)
 - **Community**
   - [📊 System Requirements](#system-requirements-)
-  - [🗨️ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-)
+  - [🗨️ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-%EF%B8%8F)
   - [📣 More Contributors Wanted](#more-contributors-wanted-)
   - [💖 Supporting Websurfx](#supporting-websurfx-)
   - [📘 Documentation](#documentation-)
-  - [🛣️ Roadmap](#roadmap-)
+  - [🛣️ Roadmap](#roadmap-%EF%B8%8F)
   - [🙋 Contributing](#contributing-)
   - [📜 License](#license-)
   - [🤝 Credits](#credits-)
@@ -105,14 +105,14 @@
 
 # Instances 🔗
 
-> For a full list of publicly available community driven `websurfx` instances to test or for daily use. see [**Instances**](./docs/instances.md)
+> For a full list of publicly available community driven `websurfx` instances to test or for daily use. see [**Instances**](docs/instances.md)
 
 **[⬆️ Back to Top](#--)**
 
 # Features 🚀
 
-- 🎨 Make Websurfx uniquely yours with twelve 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!
+- 🎨 Make Websurfx uniquely yours with the twelve color schemes provided by default. It also supports the creation of custom themes and color schemes in a quick and easy way, so unleash your creativity!
-- 🚀 Easy to setup with docker or on bare metal with various installation/deployement options. 
+- 🚀 Easy to setup with Docker or on bare metal with various installation and deployment options.
 - ⛔ Search filtering to filter search results based on four different levels.
 - 💾 Different caching levels focusing on reliability, speed and resiliancy.
 - 🔐 Fast, private, and secure
@@ -124,7 +124,7 @@
 
 # Installation and Testing 🛠️
 
-> For full setup instructions, see: [**Installation**](./docs/installation.md)
+> For full setup instructions, see: [**Installation**](docs/installation.md)
 
 Before you can start building `websurfx`, you will need to have `Cargo` installed on your system. You can find the installation instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
 
@@ -144,13 +144,13 @@ Once you have started the server, open your preferred web browser and navigate t
 > **Note**
 >
 > 1. The project is no longer in the testing phase and is now ready for production use.
-> 2. There are many features still missing like `support for image search`, `different categories`, `quick apps`, etc but they will be added soon as part of future releases.
+> 2. There are many features still missing, like `support for image search`, `different categories`, `quick apps`, etc., but they will be added soon as part of future releases.
 
 **[⬆️ Back to Top](#--)**
 
 # Configuration 🔧
 
-> For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
+> For full configuration instructions, see: [**Configuration**](docs/configuration.md)
 
 Websurfx is configured through the config.lua file, located at `websurfx/config.lua`.
 
@@ -158,7 +158,7 @@ Websurfx is configured through the config.lua file, located at `websurfx/config.
 
 # Theming 🎨
 
-> For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
+> For full theming and customization instructions, see: [**Theming**](docs/theming.md)
 
 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.
 
@@ -167,7 +167,7 @@ Websurfx comes loaded with several themes and color schemes, which you can apply
 # Multi-Language Support 🌍
 
 > **Note**
-> 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.
+> 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.
 
 **[⬆️ Back to Top](#--)**
 
@@ -181,7 +181,7 @@ At present, we only support x86_64 architecture systems, but we would love to ha
 
 ## Why Websurfx?
 
-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).
+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 engines, 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 foolproof 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).
 
 ## Why AGPLv3?
 
@@ -189,7 +189,7 @@ Websurfx is distributed under the **AGPLv3** license to keep the source code ope
 
 ## Why Rust?
 
-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.
+Websurfx is based on Rust due to its memory safety features, which prevent vulnerabilities and make 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.
 
 **[⬆️ Back to Top](#--)**
 
@@ -201,16 +201,16 @@ We are looking for more willing contributors to help grow this project. For more
 
 # Supporting Websurfx 💖
 
-> For full details and other ways you can help out, see: [**Contributing**]()
+> For full details and other ways you can help out, see: [**Contributing**](CONTRIBUTING.md)
 
 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.
 
 Several areas that we need a bit of help with at the moment are:
 
 - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
-- **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
+- **Improve evasion code for bot detection**: Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
-- **Logo** - Help create a logo for the project and website.
+- **Logo**: Help create a logo for the project and website.
-- **Docker Support** - Help write a Docker Compose file for the project.
+- **Docker Support**: Help write a Docker Compose file for the project.
 - Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or anything else.
 - Star Websurfx on GitHub.
 
@@ -219,7 +219,7 @@ Several areas that we need a bit of help with at the moment are:
 # Documentation 📘
 
 > **Note**
-> We welcome any contributions to the [documentation](../../tree/HEAD/docs/) as this will benefit everyone who uses this project.
+> We welcome any contributions to the [documentation](docs) as this will benefit everyone who uses this project.
 
 **[⬆️ Back to Top](#--)**
 
@@ -239,7 +239,7 @@ Check out this [video](https://youtu.be/FccdqCucVSI) by Mr. Nick on how to contr
 
 ## Developer
 
-If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) document for more information.
+If you are a developer, have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) document for more information.
 
 **[⬆️ Back to Top](#--)**