YGGverse/Yo
1
0
Fork 0
mirror of https://github.com/YGGverse/Yo.git synced 2026-03-31 17:55:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
ghost 2023-11-24 19:55:07 +02:00
parent c6e9ba9d09
commit fb632b5a7f
1 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -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. 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
Codebase following minimalism such as possible. - Snaps now using tar.gz compression to reduce storage requirements and still supporting remote mirrors, FTP including
- Codebase following minimalism everywhere as possible.
## Implementation ## Implementation
@ -18,18 +19,18 @@ Default build inspired and adapted for [Yggdrasil](https://github.com/yggdrasil-
* JS-less frontend to make search web portal * JS-less frontend to make search web portal
* API tools to make search index distributed * API tools to make search index distributed
### Features ## Features
* MIME-based crawler with flexible filter settings * MIME-based crawler with flexible filter settings
* Page snap history with local and remote mirrors support * Page snap history with local and remote mirrors support
### Documentation ## Documentation
#### CLI ### CLI
##### Index #### Index
###### Init ##### Init
Create initial index Create initial index
@ -38,22 +39,22 @@ php src/cli/index/init.php [reset]
``` ```
* `reset` - optional, reset existing index * `reset` - optional, reset existing index
##### Document #### Document
###### Add ##### Add
``` ```
php src/cli/document/add.php URL php src/cli/document/add.php URL
``` ```
* `URL` - add new URL to the crawl queue * `URL` - add new URL to the crawl queue
###### Crawl ##### Crawl
``` ```
php src/cli/document/crawl.php php src/cli/document/crawl.php
``` ```
###### Search ##### Search
``` ```
php src/cli/document/search.php '@title "*"' [limit] php src/cli/document/search.php '@title "*"' [limit]