From 17c6b1c48e918b4dc2c325ead8fa4b114cf90c22 Mon Sep 17 00:00:00 2001 From: ghost Date: Fri, 24 Nov 2023 20:00:09 +0200 Subject: [PATCH] update readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 01aea03..bb575ef 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Yo! Micro Web Crawler in PHP & Manticore -Next generation of [YGGo!](https://github.com/YGGverse/YGGo) project with goal to reduce server requirements and make deployment process simpler. +Next generation of [YGGo!](https://github.com/YGGverse/YGGo) project with goal to reduce server requirements and make deployment process simpler - - Index model changed to the distributed cluster model, and oriented to aggregate search results from different instances trough API. + - Index model changed to the distributed cluster model, and oriented to aggregate search results from different instances trough API - Refactored data exchange model with drop all primary keys dependencies - Snaps now using tar.gz compression to reduce storage requirements and still supporting remote mirrors, FTP including - - Codebase following minimalism everywhere as possible. + - Codebase following minimalism principles everywhere ## Implementation @@ -26,6 +26,14 @@ Default build inspired and adapted for [Yggdrasil](https://github.com/yggdrasil- ## Documentation +### Install + +1. Install php and manticore +2. Grab latest version `git clone https://github.com/YGGverse/Yo.git` +3. Check `src/config.json` for any customizations +4. Run indexes init script `php src/cli/index/init.php` +5. [Start crawling!](https://github.com/YGGverse/Yo#add) + ### CLI #### Index