neon_arch commited on
Commit
3024ef4
1 Parent(s): 28fee6b

Add preview images, changes to installation step and add FAQ

Browse files
README.org CHANGED
@@ -2,6 +2,19 @@
2
 
3
  a lightening 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//.)
4
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
 
6
  * Installation and Testing
7
 
@@ -14,10 +27,34 @@ To start installing, testing and playing around with search engine. Clone the re
14
  ./target/debug/websurfx --port 8080
15
  #+end_src
16
 
 
 
 
 
 
 
 
 
 
 
17
  and then open your browser of choice and visit [[http://127.0.0.1:8080]] and then you can start playing with it right away.
18
 
19
  *Important Note:* Do not over refresh your page or put too many requests or start hosting on production server as there are no behaviours right now in the code to prevent ip blocking (it is still work under process) and you can potential can get your ip blocked/banned and also the project is still under testing phase and far from being complete and ready to be hosted on production machines.
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  * Contributing
22
 
23
  Contributions are welcome. It does not matter who you are you can still contribute to the project in your way :).
 
2
 
3
  a lightening 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//.)
4
 
5
+ * Preview
6
+
7
+ ** Main Page
8
+
9
+ [[file:images/main_page.png]]
10
+
11
+ ** Search Page
12
+
13
+ [[file:images/search_page.png]]
14
+
15
+ ** 404 Error Page
16
+
17
+ [[file:images/404_error_page.png]]
18
 
19
  * Installation and Testing
20
 
 
27
  ./target/debug/websurfx --port 8080
28
  #+end_src
29
 
30
+ If you want to be on the rolling/edge branch then do the following steps:
31
+
32
+ #+begin_src shell
33
+ git clone https://gitlab.com/NEON-MMD/websurfx.git
34
+ cd websurfx
35
+ git checkout rolling
36
+ cargo build
37
+ ./target/debug/websurfx --port 8080
38
+ #+end_src
39
+
40
  and then open your browser of choice and visit [[http://127.0.0.1:8080]] and then you can start playing with it right away.
41
 
42
  *Important Note:* Do not over refresh your page or put too many requests or start hosting on production server as there are no behaviours right now in the code to prevent ip blocking (it is still work under process) and you can potential can get your ip blocked/banned and also the project is still under testing phase and far from being complete and ready to be hosted on production machines.
43
 
44
+ * FAQ (Frequently Asked Questions)
45
+
46
+ ** Why Websurfx?
47
+
48
+ The main goal of the project is to provide a fast, secure and privacy focused [[https://en.wikipedia.org/wiki/Metasearch_engine][meta search engine]]. Though there are many meta search engine out there but they don't provide gaurantee security of the their search engine which is essential because sometimes privacy is related to security like for example some memory vulnerabilities can leak private or sensitive information which is never good so the project being written in rust gaurantees memory safety and thus eliminating such problems.
49
+
50
+ ** Why GPLv3?
51
+
52
+ The reason why I am releasing my meta search engine under *GPLv3* is because my main motive of this meta search is to provide privacy, speed and security to the user and *AGPL licensing or closed sourcing or any other licensing* makes it loose for the user/server admin to not release the source code which is shady because you never know what he is putting in the source code lets say he is adding telemetry, spyware stuff, logging and what not which gets shady and is against privacy.
53
+
54
+ ** Why Rust?
55
+
56
+ Rust provides memory safe code which eliminates issues relating memory based vulnerabilites which makes the project more secure and less vulnerable to memory based bugs and issues and also rust being a faster programming language than c++ provides a much faster, smooth and secure meta search engine :).
57
+
58
  * Contributing
59
 
60
  Contributions are welcome. It does not matter who you are you can still contribute to the project in your way :).
images/404_error_page.png ADDED
images/main_page.png ADDED
images/search_page.png ADDED