From 7325c3a23feadd6b09b586e092e87e5c69453181 Mon Sep 17 00:00:00 2001
From: ghost <noreply@localhost>
Date: Sat, 1 Apr 2023 19:40:37 +0300
Subject: [PATCH] add readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..436d76d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+### YGGo! - Open Source Web Search Engine
+
+Written of Yggdrasil ecosystem research inspiration.
+Could be using for crawling regular websites, small business resources, local networks
+
+#### Web nodes
+
+http://[201:23b4:991a:634d:8359:4521:5576:15b7]/yggo (yggdrasil network)
+http://94.140.114.241/yggo
+
+#### Requirements
+
+```
+php 8
+php-php
+php-pdo
+curl-curl
+sqlite / fts5
+```
+
+#### TODO / ideas
+
+* [x] Web pages search
+* [] Images search (basically implemented but requires testing and some performance optimization)
+* [] Distributed index data sharing between the nodes trough service API
\ No newline at end of file