From fb632b5a7f3a97bfaf71341fa38403527af144c6 Mon Sep 17 00:00:00 2001 From: ghost Date: Fri, 24 Nov 2023 19:55:07 +0200 Subject: [PATCH] update readme --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a2ffc88..01aea03 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ 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. - -Codebase following minimalism such as possible. + - 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. ## Implementation @@ -18,18 +19,18 @@ Default build inspired and adapted for [Yggdrasil](https://github.com/yggdrasil- * JS-less frontend to make search web portal * API tools to make search index distributed -### Features +## Features * MIME-based crawler with flexible filter settings * Page snap history with local and remote mirrors support -### Documentation +## Documentation -#### CLI +### CLI -##### Index +#### Index -###### Init +##### Init Create initial index @@ -38,22 +39,22 @@ php src/cli/index/init.php [reset] ``` * `reset` - optional, reset existing index -##### Document +#### Document -###### Add +##### Add ``` php src/cli/document/add.php URL ``` * `URL` - add new URL to the crawl queue -###### Crawl +##### Crawl ``` php src/cli/document/crawl.php ``` -###### Search +##### Search ``` php src/cli/document/search.php '@title "*"' [limit]