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 19:31:27 +03:00
parent 048ae2c3ac
commit e3a1b6c06b
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -12,11 +12,18 @@ RSS Aggregator
* `nex://[301:23b4:991a:634d::feed]` - [Yggdrasil](https://github.com/yggdrasil-network/yggdrasil-go) instance by YGGverse * `nex://[301:23b4:991a:634d::feed]` - [Yggdrasil](https://github.com/yggdrasil-network/yggdrasil-go) instance by YGGverse
## Usage ## Install
1. `apt install git composer php-fpm php-pdo php-mbstring` - install dependencies 1. `apt install git composer php-fpm php-pdo php-mbstring` - install system dependencies
2. `git clone https://github.com/YGGverse/Pulsar.git` 2. `git clone https://github.com/YGGverse/Pulsar.git` - get latest Pulsar version
3. `cd Pulsar` - navigate project folder 3. `cd Pulsar` - navigate project folder
4. `composer update` - grab latest dependencies 4. `composer update` - install application dependencies
5. `cp config/example.json name.json` - setup your feed 5. `cp config/example.json name.json` - setup your feed
6. `php src/crawler.php config=name.json` - crawl feeds configured by `name.json` - manually or using crontab
## Launch
* `php src/crawler.php config=name.json` - crawl feeds configured by `name.json` - manually or using crontab
### Arguments
* `config` - relative (to `config` folder) or absolute path to configuration file