diff --git a/README.md b/README.md index 0721b9b..ba1c158 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,48 @@ + + # Beehive for YunoHost -![](https://raw.githubusercontent.com/muesli/beehive/master/assets/logo_256.png) - -[![Integration level](https://dash.yunohost.org/integration/beehive.svg)](https://dash.yunohost.org/appci/app/beehive) ![](https://ci-apps.yunohost.org/ci/badges/beehive.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/beehive.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/beehive.svg)](https://dash.yunohost.org/appci/app/beehive) ![](https://ci-apps.yunohost.org/ci/badges/beehive.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/beehive.maintain.svg) [![Install Beehive with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=beehive) +*[Lire ce readme en français.](./README_fr.md)* > *This package allows you to install Beehive 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 -Beehive is an event and agent system, which allows you to create your own agents that perform automated tasks triggered by events and filters. It is modular, flexible and really easy to extend for anyone. It has modules (we call them Hives), so it can interface with, talk to, or retrieve information from Twitter, Tumblr, Email, IRC, Jabber, RSS, Jenkins, Hue - to name just a few. -Available hives: [Click here](https://github.com/muesli/beehive/wiki/Available-Hives) +Beehive is an event and agent system, which allows you to create your own agents that perform automated tasks triggered by events and filters. It is modular, flexible and really easy to extend for anyone. It has modules (we call them Hives), so it can interface with, talk to, or retrieve information from Twitter, Tumblr, Email, IRC, Jabber, RSS, Jenkins, Hue - to name just a few. -**Shipped version:** 28.01.2021 +### Features: + +- Re-post tweets on your Tumblr blog +- Forward incoming chat messages to your email account +- Turn on the heating system if the temperature drops below a certain value +- Run your own IRC bot that lets you trigger builds on a Jenkins CI +- Control your Hue lighting system +- Notify you when a stock's price drops below a certain value + + +**Shipped version:** 0.4.0~ynh1 + +**Demo:** https://github.com/muesli/beehive/wiki/Available-Hives ## Screenshots -![](https://raw.githubusercontent.com/muesli/beehive-docs/master/screencaps/new_bees.gif) +![](./doc/screenshots/screenshot1.gif) -## YunoHost specific features +## Documentation and resources -#### Multi-user support - -Are LDAP and HTTP auth supported? No -Can the app be used by multiple users? Yes - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/beehive%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/beehive/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/beehive%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/beehive/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/beehive_ynh/issues - * Upstream app repository: https://github.com/muesli/beehive - * YunoHost website: https://yunohost.org/ - ---- +* Upstream app code repository: https://github.com/muesli/beehive +* YunoHost documentation for this app: https://yunohost.org/app_beehive +* Report a bug: https://github.com/YunoHost-Apps/beehive_ynh/issues ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/beehive_ynh/tree/testing). To try the testing branch, please proceed like that. @@ -51,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/beehive_ynh/tree/test or sudo yunohost app upgrade beehive -u https://github.com/YunoHost-Apps/beehive_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..a3c1dbe --- /dev/null +++ b/README_fr.md @@ -0,0 +1,51 @@ +# Beehive pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/beehive.svg)](https://dash.yunohost.org/appci/app/beehive) ![](https://ci-apps.yunohost.org/ci/badges/beehive.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/beehive.maintain.svg) +[![Installer Beehive avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=beehive) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Beehive 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 + +Beehive is an event and agent system, which allows you to create your own agents that perform automated tasks triggered by events and filters. It is modular, flexible and really easy to extend for anyone. It has modules (we call them Hives), so it can interface with, talk to, or retrieve information from Twitter, Tumblr, Email, IRC, Jabber, RSS, Jenkins, Hue - to name just a few. + +### Features: + +- Re-post tweets on your Tumblr blog +- Forward incoming chat messages to your email account +- Turn on the heating system if the temperature drops below a certain value +- Run your own IRC bot that lets you trigger builds on a Jenkins CI +- Control your Hue lighting system +- Notify you when a stock's price drops below a certain value + + +**Version incluse :** 0.4.0~ynh1 + +**Démo :** https://github.com/muesli/beehive/wiki/Available-Hives + +## Captures d'écran + +![](./doc/screenshots/screenshot1.gif) + +## Documentations et ressources + +* Dépôt de code officiel de l'app : https://github.com/muesli/beehive +* Documentation YunoHost pour cette app : https://yunohost.org/app_beehive +* Signaler un bug : https://github.com/YunoHost-Apps/beehive_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/beehive_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/beehive_ynh/tree/testing --debug +ou +sudo yunohost app upgrade beehive -u https://github.com/YunoHost-Apps/beehive_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file