DotLasher commited on
Commit
eceef03
β€’
1 Parent(s): 9271090

Added a link to the(#251) user showcase

Browse files
Files changed (1) hide show
  1. README.md +20 -27
README.md CHANGED
@@ -4,6 +4,7 @@
4
  <p align="center">
5
  <b align="center"><a href="README.md">Readme</a></b> |
6
  <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
 
7
  <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
8
  <b><a href="../../tree/HEAD/docs/">Documentation</a></b>
9
  <br /><br />
@@ -57,28 +58,19 @@
57
  <p>
58
 
59
  - **Getting Started**
60
- - [πŸ”­ Preview](#preview-)
61
- - [πŸš€ Features](#features-)
62
- - [πŸ› οΈ Installation and Testing](#installation-and-testing-%EF%B8%8F)
63
- - [πŸ”§ Configuration](#configuration-)
64
  - **Feature Overview**
65
- - [🎨 Theming](#theming-)
66
- - [🌍 Multi-Language Support](#multi-language-support-)
67
- - **Community**
68
- - [πŸ“Š System Requirements](#system-requirements-)
69
- - [πŸ—¨οΈ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-)
70
- - [πŸ“£ More Contributors Wanted](#more-contributors-wanted-)
71
- - [πŸ’– Supporting Websurfx](#supporting-websurfx-)
72
- - [πŸ“˜ Documentation](#documentation-)
73
- - [πŸ›£οΈ Roadmap](#roadmap-)
74
- - [πŸ™‹ Contributing](#contributing-)
75
- - [πŸ“œ License](#license-)
76
- - [🀝 Credits](#credits-)
77
 
78
  </p>
79
  </details>
80
 
81
- # Preview πŸ”­
82
 
83
  ## Home Page
84
 
@@ -94,7 +86,7 @@
94
 
95
  **[⬆️ Back to Top](#--)**
96
 
97
- # Features πŸš€
98
 
99
  - 🎨 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!
100
  - πŸ” Fast, private, and secure
@@ -104,7 +96,7 @@
104
 
105
  **[⬆️ Back to Top](#--)**
106
 
107
- # Installation and Testing πŸ› οΈ
108
 
109
  > For full setup instructions, see: [**Installation**](./docs/installation.md)
110
 
@@ -112,7 +104,7 @@ Before you can start building `websurfx`, you will need to have `Cargo` installe
112
 
113
  To get started with Websurfx, clone the repository, edit the config file, which is located in the `websurfx/` 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:
114
 
115
- ``` shell
116
  git clone https://github.com/neon-mmd/websurfx.git
117
  cd websurfx
118
  git checkout stable
@@ -128,7 +120,7 @@ Once you have started the server, open your preferred web browser and navigate t
128
 
129
  **[⬆️ Back to Top](#--)**
130
 
131
- # Configuration πŸ”§
132
 
133
  > For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
134
 
@@ -136,7 +128,7 @@ Websurfx is configured through the config.lua file, located at `websurfx/config.
136
 
137
  **[⬆️ Back to Top](#--)**
138
 
139
- # Theming 🎨
140
 
141
  > For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
142
 
@@ -173,7 +165,7 @@ Websurfx is based on Rust due to its memory safety features, which prevents vuln
173
 
174
  **[⬆️ Back to Top](#--)**
175
 
176
- # More Contributors Wanted πŸ“£
177
 
178
  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.
179
 
@@ -186,6 +178,7 @@ We are looking for more willing contributors to help grow this project. For more
186
  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.
187
 
188
  Several areas that we need a bit of help with at the moment are:
 
189
  - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
190
  - **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
191
  - **Logo** - Help create a logo for the project and website.
@@ -198,7 +191,7 @@ Several areas that we need a bit of help with at the moment are:
198
  # Documentation πŸ“˜
199
 
200
  > **Note**
201
- > We welcome any contributions to the [documentation](../../tree/HEAD/docs/) as this will benefit everyone who uses this project.
202
 
203
  **[⬆️ Back to Top](#--)**
204
 
@@ -208,7 +201,7 @@ Several areas that we need a bit of help with at the moment are:
208
 
209
  **[⬆️ Back to Top](#--)**
210
 
211
- # Contributing πŸ™‹
212
 
213
  Contributions are welcome from anyone. It doesn't matter who you are; you can still contribute to the project in your own way.
214
 
@@ -222,13 +215,13 @@ If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) d
222
 
223
  **[⬆️ Back to Top](#--)**
224
 
225
- # License πŸ“œ
226
 
227
  Websurfx is licensed under the [AGPLv3](LICENSE) license.
228
 
229
  **[⬆️ Back to Top](#--)**
230
 
231
- # Credits 🀝
232
 
233
  We would like to thank the following people for their contributions and support:
234
 
 
4
  <p align="center">
5
  <b align="center"><a href="README.md">Readme</a></b> |
6
  <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
7
+ <b><a href="https://discord.gg/VKCAememnr">User Showcase</a></b> |
8
  <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
9
  <b><a href="../../tree/HEAD/docs/">Documentation</a></b>
10
  <br /><br />
 
58
  <p>
59
 
60
  - **Getting Started**
61
+ - [πŸ”­ Preview](#preview-)
62
+ - [πŸš€ Features](#features-)
63
+ - [πŸ› οΈ Installation and Testing](#installation-and-testing-%EF%B8%8F)
64
+ - [πŸ”§ Configuration](#configuration-)
65
  - **Feature Overview**
66
+ - [🎨 Theming](#theming-)
67
+ - [🌍 Multi-Language Support](#multi-language-support-)
68
+ - **Community** - [πŸ“Š System Requirements](#system-requirements-) - [πŸ—¨οΈ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-) - [πŸ“£ More Contributors Wanted](#more-contributors-wanted-) - [πŸ’– Supporting Websurfx](#supporting-websurfx-) - [πŸ“˜ Documentation](#documentation-) - [πŸ›£οΈ Roadmap](#roadmap-) - [πŸ™‹ Contributing](#contributing-) - [πŸ“œ License](#license-) - [🀝 Credits](#credits-)
 
 
 
 
 
 
 
 
 
69
 
70
  </p>
71
  </details>
72
 
73
+ # Preview πŸ”­
74
 
75
  ## Home Page
76
 
 
86
 
87
  **[⬆️ Back to Top](#--)**
88
 
89
+ # Features πŸš€
90
 
91
  - 🎨 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!
92
  - πŸ” Fast, private, and secure
 
96
 
97
  **[⬆️ Back to Top](#--)**
98
 
99
+ # Installation and Testing πŸ› οΈ
100
 
101
  > For full setup instructions, see: [**Installation**](./docs/installation.md)
102
 
 
104
 
105
  To get started with Websurfx, clone the repository, edit the config file, which is located in the `websurfx/` 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:
106
 
107
+ ```shell
108
  git clone https://github.com/neon-mmd/websurfx.git
109
  cd websurfx
110
  git checkout stable
 
120
 
121
  **[⬆️ Back to Top](#--)**
122
 
123
+ # Configuration πŸ”§
124
 
125
  > For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
126
 
 
128
 
129
  **[⬆️ Back to Top](#--)**
130
 
131
+ # Theming 🎨
132
 
133
  > For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
134
 
 
165
 
166
  **[⬆️ Back to Top](#--)**
167
 
168
+ # More Contributors Wanted πŸ“£
169
 
170
  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.
171
 
 
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
+
182
  - **Better and more color schemes**: Help fix color schemes and add other famous color schemes.
183
  - **Improve evasion code for bot detection** - Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
184
  - **Logo** - Help create a logo for the project and website.
 
191
  # Documentation πŸ“˜
192
 
193
  > **Note**
194
+ > We welcome any contributions to the [documentation](../../tree/HEAD/docs/) as this will benefit everyone who uses this project.
195
 
196
  **[⬆️ Back to Top](#--)**
197
 
 
201
 
202
  **[⬆️ Back to Top](#--)**
203
 
204
+ # Contributing πŸ™‹
205
 
206
  Contributions are welcome from anyone. It doesn't matter who you are; you can still contribute to the project in your own way.
207
 
 
215
 
216
  **[⬆️ Back to Top](#--)**
217
 
218
+ # License πŸ“œ
219
 
220
  Websurfx is licensed under the [AGPLv3](LICENSE) license.
221
 
222
  **[⬆️ Back to Top](#--)**
223
 
224
+ # Credits 🀝
225
 
226
  We would like to thank the following people for their contributions and support:
227