From e3a1b6c06bce887ded74bd54235720f68c5acef7 Mon Sep 17 00:00:00 2001 From: yggverse Date: Sat, 4 May 2024 19:31:27 +0300 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 253926d..d9fadce 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,18 @@ RSS Aggregator * `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 -2. `git clone https://github.com/YGGverse/Pulsar.git` +1. `apt install git composer php-fpm php-pdo php-mbstring` - install system dependencies +2. `git clone https://github.com/YGGverse/Pulsar.git` - get latest Pulsar version 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 -6. `php src/crawler.php config=name.json` - crawl feeds configured by `name.json` - manually or using crontab \ No newline at end of file + +## 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 \ No newline at end of file