aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLia Lenckowski <lialenck@protonmail.com>2023-08-17 11:19:23 +0200
committerLia Lenckowski <lialenck@protonmail.com>2023-08-17 11:20:41 +0200
commit6ba3442ac42da3a72c0781fe5263052ff7cec820 (patch)
treefaa24422f92a0d9308218308b84a0d81394e0e33
parent11c37ae6f978aeffb7fd3e0d0ce6279879f679b7 (diff)
downloadfastbangs-6ba3442ac42da3a72c0781fe5263052ff7cec820.tar
fastbangs-6ba3442ac42da3a72c0781fe5263052ff7cec820.tar.bz2
fastbangs-6ba3442ac42da3a72c0781fe5263052ff7cec820.tar.zst
add readme
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99a092b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# fastbangs
+This project functions as a meta search engine, resolving shortcuts to other search engines we call "bangs" (which work the same as the bangs from duckduckgo). When no bang is given, the user will be redirected to a default search engine, which is configurable by each user. This evaluation is done on the client; the server doesn't ever see your search query.
+The server keeps its own list of bangs, initialized with those from duckduckgo. Users are thus able to submit their own bangs on the website, which need to be approved by an administrator before coming into effect for all users.
+
+There is a public instance running at [search.metamuffin.org](https://search.metamuffin.org), running on a server in germany.