aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorfrosty <gabriel@bwaaa.monster>2026-03-16 22:33:22 -0400
committerfrosty <gabriel@bwaaa.monster>2026-03-16 22:33:22 -0400
commit1c4ec1e5bdc951ae037c1760df3b9e104b2b552f (patch)
treec7c1b46780af8e9d093c279358fed18132af48c1 /README.md
parent0317ff26d5de091fd3717e97bb1ee38f3011a25d (diff)
downloadomnisearch-1c4ec1e5bdc951ae037c1760df3b9e104b2b552f.tar.gz
docs: Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 28ab9c9..1817290 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# OmniSearch
-A modern lightweight metasearch engine with a clean design written in C. [You can try using it here!](https://search.bwaaa.monster/)
+A modern lightweight metasearch engine with a clean design written in C.
## Configuration
Create a config.ini, there is an example included in the root.
@@ -10,12 +10,22 @@ Create a config.ini, there is an example included in the root.
- libcurl (may be replaced in the future with curl-impersonate)
- beaker [(source)](https://git.bwaaa.monster/beaker/)
-## Running
-```bash
-git clone https://git.bwaaa.monster/omnisearch/
-cd omnisearch
-make run
+# First Setup
+Firstly, install libbeaker:
```
+$ git clone https://git.bwaaa.monster/beaker
+$ cd beaker
+$ make
+# make install
+```
+And then install omnisearch:
+```
+$ git clone https://git.bwaaa.monster/omnisearch
+$ cd omnisearch
+$ make
+# make install-<init>
+```
+Replace `<init>` with your init system (openrc,systemd,runit,s6)
## Hosting
Run it normally behind a reverse proxy (like nginx)