YGGverse/Pulsar
1
0
Fork 0
mirror of https://github.com/YGGverse/Pulsar.git synced 2026-03-31 09:45:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
yggverse 2024-05-04 20:41:49 +03:00
parent 43cd1a1b96
commit 5b4564d446
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,12 +1,14 @@
# Pulsar
RSS Aggregator
RSS Aggregator for different protocols
## Components
## Features
* [x] `src/crawler.php` - scan configured RSS feeds and dump results to SQLite (see also [alternative branch](https://github.com/YGGverse/Pulsar/tree/fs))
* [ ] `src/nex.php` - server for [NEX Protocol](https://nightfall.city/nps/info/specification.txt)
* [ ] `src/gemini.php` - server for [Gemini Protocol](https://geminiprotocol.net)
* [x] `src/crawler.php` - scan configured RSS feeds and dump results to SQLite DB (see also [alternative branch](https://github.com/YGGverse/Pulsar/tree/fs))
* [ ] `src/cleaner.php` - auto clean deprecated records in database
* [x] `src/server.php` - server launcher with multiple host support, based on [Ratchet](https://github.com/ratchetphp/Ratchet) asynchronous socket library
* [x] [NEX Protocol](https://nightfall.city/nps/info/specification.txt)
* [ ] [Gemini Protocol](https://geminiprotocol.net)
## Example
@ -20,7 +22,14 @@ RSS Aggregator
4. `composer update` - install application dependencies
5. `cp config/example.json name.json` - setup your feed
## Crawl
## Crawler
* `php src/crawler.php config=name.json` - crawl feeds configured by `name.json` - manually or using crontab
* `config` - relative (to `config` folder) or absolute path to configuration file
## Server
* `php src/server.php protocol=NPS config=name.json` - launch `NPS` server configured by `name.json`
* `protocol` - supported options:
* `NPS`
* `config` - relative (to `config` folder) or absolute path to configuration file