diff --git a/README.md b/README.md index bae5338..6dfab1c 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,41 @@ + + # RSS-Bridge for YunoHost [![Integration level](https://dash.yunohost.org/integration/rss-bridge.svg)](https://dash.yunohost.org/appci/app/rss-bridge) ![](https://ci-apps.yunohost.org/ci/badges/rss-bridge.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rss-bridge.maintain.svg) -[![Install RSS-Bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=rss-bridge) +[![Install RSS-Bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rss-bridge) -> *This package allow you to install RSS-Bridge quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install RSS-Bridge quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -[RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge) is a PHP project capable of generating ATOM feeds for websites which don't have one. -**Shipped version:** 2021-04-25 +RSS and Atom feed generator for websites that don't have one. -### Supported sites/pages (main) +**Shipped version:** 2021-04-25~ynh1 - * `FlickrExplore` : [Latest interesting images](http://www.flickr.com/explore) from Flickr - * `GoogleSearch` : Most recent results from Google Search - * `GooglePlus` : Most recent posts of user timeline - * `Twitter` : Return keyword/hashtag search or user timeline - * `Identi.ca` : Identica user timeline (Should be compatible with other Pump.io instances) - * `YouTube` : YouTube user channel, playlist or search - * `Cryptome` : Returns the most recent documents from [Cryptome.org](http://cryptome.org/) - * `DansTonChat`: Most recent quotes from [danstonchat.com](http://danstonchat.com/) - * `DuckDuckGo`: Most recent results from [DuckDuckGo.com](https://duckduckgo.com/) - * `Instagram`: Most recent photos from an Instagram user - * `OpenClassrooms`: Lastest tutorials from [fr.openclassrooms.com](http://fr.openclassrooms.com/) - * `Pinterest`: Most recent photos from user or search - * `ScmbBridge`: Newest stories from [secouchermoinsbete.fr](http://secouchermoinsbete.fr/) - * `Wikipedia`: highlighted articles from [Wikipedia](https://wikipedia.org/) in English, German, French or Esperanto - * `Bandcamp` : Returns last release from [bandcamp](https://bandcamp.com/) for a tag - * `ThePirateBay` : Returns the newest indexed torrents from [The Pirate Bay](https://thepiratebay.se/) with keywords - * `Facebook` : Returns the latest posts on a page or profile on [Facebook](https://facebook.com/) - -Plus [many other bridges](bridges/) to enable, thanks to the community - -### Output format - -Output format can take several forms: - - * `Atom` : ATOM Feed, for use in RSS/Feed readers - * `Mrss` : MRSS Feed, for use in RSS/Feed readers - * `Json` : Json, for consumption by other applications. - * `Html` : Simple html page. - * `Plaintext` : raw text (php object, as returned by print_r) +**Demo:** https://wtf.roflcopter.fr/rss-bridge/ ## Screenshots -![image](https://github.com/RSS-Bridge/rss-bridge/wiki/images/screenshot_rss-bridge_welcome.png) +![](./doc/screenshots/screenshot_rss-bridge_welcome.png) -RSS-Bridge hashtag (#rss-bridge) search on Twitter, in ATOM format (as displayed by Firefox): +## Documentation and resources -![image](https://github.com/RSS-Bridge/rss-bridge/wiki/images/screenshot_twitterbridge_atom.png) +* Official app website: https://github.com/RSS-Bridge/rss-bridge +* Official admin documentation: https://github.com/RSS-Bridge/rss-bridge/wiki +* Upstream app code repository: https://github.com/RSS-Bridge/rss-bridge +* YunoHost documentation for this app: https://yunohost.org/app_rss-bridge +* Report a bug: https://github.com/YunoHost-Apps/rss-bridge_ynh/issues -## Demo +## Developer info -* [Official demo](https://wtf.roflcopter.fr/rss-bridge/) - -## Configuration - -### Enabling/Disabling bridges - -By default, the script creates `whitelist.txt` and adds the main bridges (see above). you can edit it: - - * to enable extra bridges (one bridge per line) - * to disable main bridges (remove the line) - * to enable all bridges (just one wildcard `*` as file content) - -As a matter of simplicity, this YunoHost package enables every bridge by default. - -## Documentation - - * Official documentation: https://github.com/RSS-Bridge/rss-bridge/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-users support - -This is application is public and there's no notion of user. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/rss-bridge.svg)](https://ci-apps.yunohost.org/ci/apps/rss-bridge/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/rss-bridge.svg)](https://ci-apps-arm.yunohost.org/ci/apps/rss-bridge/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other information you would add about this application - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/rss-bridge_ynh/issues - * App website: https://github.com/RSS-Bridge/rss-bridge - * Upstream app repository: https://github.com/RSS-Bridge/rss-bridge - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -110,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/t or sudo yunohost app upgrade rss-bridge -u https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..a8b5dbb --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# RSS-Bridge pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/rss-bridge.svg)](https://dash.yunohost.org/appci/app/rss-bridge) ![](https://ci-apps.yunohost.org/ci/badges/rss-bridge.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rss-bridge.maintain.svg) +[![Installer RSS-Bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rss-bridge) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer RSS-Bridge rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Générateur de flux RSS et Atom pour les sites Web qui n'en ont pas. + +**Version incluse :** 2021-04-25~ynh1 + +**Démo :** https://wtf.roflcopter.fr/rss-bridge/ + +## Captures d'écran + +![](./doc/screenshots/screenshot_rss-bridge_welcome.png) + +## Documentations et ressources + +* Site officiel de l'app : https://github.com/RSS-Bridge/rss-bridge +* Documentation officielle de l'admin : https://github.com/RSS-Bridge/rss-bridge/wiki +* Dépôt de code officiel de l'app : https://github.com/RSS-Bridge/rss-bridge +* Documentation YunoHost pour cette app : https://yunohost.org/app_rss-bridge +* Signaler un bug : https://github.com/YunoHost-Apps/rss-bridge_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing --debug +ou +sudo yunohost app upgrade rss-bridge -u https://github.com/YunoHost-Apps/rss-bridge_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file