aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd32316
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Takeoff!
+
+A very crude start page.
+
+## Raison d'être
+
+I just wanted a quick way of searching through different searXNG instances. It's
+a very crude and overkill implementation (it could have easily been made without
+a backend, i.e. html/css-only), but I might add some other bells and whistles
+here and there for which the backend might be of help.
+
+It was made just to serve my needs as a start page and nothing more.
+
+## Configuration
+
+The searXNG instances should be listed in `config/instances`, one per each line
+without `http(s)://`.
+
+Languages to be made available as an option should be listed in `config/langs`
+where each line is a separate language with the first column being the language
+code and the second column (separated by a single tab character) the
+human-friendly name of the language.
+
+## TODO
+
+* Weather at server location