YGGverse/Pulsar
1
0
Fork 0
mirror of https://github.com/YGGverse/Pulsar.git synced 2026-04-01 18:25:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -7,12 +7,12 @@ Simple RSS feed converter to static Gemtext format, useful for news portals or l
## Usage ## Usage
1. `git clone https://github.com/YGGverse/Pulsar.git` 1. `git clone https://github.com/YGGverse/Pulsar.git`
2. `cp example/config.json config.json` - setup your feeds there! 2. `cp example/config.json config.json` - setup your feeds
3. `php src/crawler.php` - crontab schedule 3. `php src/crawler.php` - create crontab schedule
## Config ## 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 * `source` - string, filepath or URL to the valid RSS feed
* `target` - string, relative or absolute path to Gemtext dumps * `target` - string, relative or absolute path to Gemtext dumps
@ -27,7 +27,3 @@ Configuration file supports multiple feed channels with custom configurations:
* `{description}` - item description * `{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). 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!