YGGverse/Pulsar
1
0
Fork 0
mirror of https://github.com/YGGverse/Pulsar.git synced 2025-03-13 05:41:21 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yggverse 2024-04-19 17:11:03 +03:00
parent a09f941a55
commit d297b16523
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,12 +7,12 @@ Simple RSS feed converter to static Gemtext format, useful for news portals or l
## Usage
1. `git clone https://github.com/YGGverse/Pulsar.git`
2. `cp example/config.json config.json` - setup your feeds there!
3. `php src/crawler.php` - crontab schedule
2. `cp example/config.json config.json` - setup your feeds
3. `php src/crawler.php` - create crontab schedule
## Config
Configuration file supports multiple feed channels with custom configurations:
Configuration file supports multiple feed channels with custom settings:
* `source` - string, filepath or URL to the valid RSS feed
* `target` - string, relative or absolute path to Gemtext dumps
@ -26,8 +26,4 @@ Configuration file supports multiple feed channels with custom configurations:
* `{title}` - item title
* `{description}` - item description
Resulting files could be generated to the any folder for personal reading on localhost, or shared with others using [gmid](https://github.com/omar-polo/gmid), [twins](https://code.rocket9labs.com/tslocum/twins) or any other [Gemini server](https://github.com/kr1sp1n/awesome-gemini#servers).
## Instances
Coming soon!
Resulting files could be generated to the any folder for personal reading on localhost, or shared with others using [gmid](https://github.com/omar-polo/gmid), [twins](https://code.rocket9labs.com/tslocum/twins) or any other [Gemini server](https://github.com/kr1sp1n/awesome-gemini#servers).