commit 45c20abcdb2c589410846eab994ff03d52fcebbb
parent f6e365ed5dc85c3d18b8fb3c6895c7a65c8ea7a5
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 6 Jul 2024 14:51:28 +0200
feat: information about usage
Diffstat:
2 files changed, 25 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -37,9 +37,27 @@ traserĉi yourself any time and configure your own favorite search engines and
If you think there are `!bangs` that other people would benefit from, feel free
to contribute!
+3. How can I use traserĉi?
+
+ - You can try traserĉi on [search.jayvii.de](https://search.jayvii.de). Or
+ host it yourself! It barely needs any server resources, no database or lots
+ of RAM. traserĉi has minimal footprint (also on user data: there are NONE).
+ - Either type your search directly into the search bar of the traserĉi
+ webfrontend or add the search to your browser by rightclicking in the
+ URL-bar and choosing `add traserĉi - Search with !bangs`.
+ - Some browsers (for example Firefox on Android / Fennec) allow to configure
+ custom search engines via search URL. Simply list
+ `https://search.jayvii.de/?query=%s` (or whatever traserĉi host you want to
+ use).
+ - Please do not abuse my open search site search.jayvii.de and try to host
+ traserĉi yourself, if you can. There is no guarantee, my site is always
+ online or will be continued indefinitely.
+
## Hosting
-Simply upload the entire content of this repository to your webhost. Edit `opensearch.xml` accordingly. If the domain you want to run traserĉi under is `search.example.com`, you can simply run:
+Simply upload the entire content of this repository to your webhost. Edit
+`opensearch.xml` accordingly. If the domain you want to run traserĉi under is
+`search.example.com`, you can simply run:
```bash
sed -e 's/%%URL%%/https:\/\/search.example.com/g' -i opensearch.xml
diff --git a/index.php b/index.php
@@ -105,13 +105,16 @@ if (strlen($query) > 0) {
<!-- FAQs -->
<h3>FAQs</h3>
<ul>
- <li><a href="https://translate.google.com/?sl=eo&text=traser%C4%89i&op=translate" target="_blank">
+ <li><a href="https://src.jayvii.de/pub/traserci/#faqs" target="_blank">
What does <em>traserĉi</em> mean?
</a></li>
- <li><a href="https://duckduckgo.com/bangs" target="_blank">
+ <li><a href="https://src.jayvii.de/pub/traserci/#faqs" target="_blank">
What are bangs?
</a></li>
- <li><a href="https://src.jayvii.de/pub/traserci" target="_blank">
+ <li><a href="https://src.jayvii.de/pub/traserci/#faqs" target="_blank">
+ How to use traserĉi?
+ </a></li>
+ <li><a href="https://src.jayvii.de/pub/traserci/" target="_blank">
Help with development!
</a></li>
</ul>