diff --git a/README.md b/README.md index 1f62aff..b3819d8 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,41 @@ + + # Baïkal for YunoHost [![Integration level](https://dash.yunohost.org/integration/baikal.svg)](https://dash.yunohost.org/appci/app/baikal) ![](https://ci-apps.yunohost.org/ci/badges/baikal.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/baikal.maintain.svg) [![Install Baïkal with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=baikal) -> *This package allow you to install Baïkal 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 Baïkal 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 -[Baïkal](http://baikal-server.com/) is a CalDAV and CardDAV server, based on -sabre/dav, that includes an administration interface for easy management. -**Shipped version:** 0.7.1 +[Baïkal](http://baikal-server.com/) is a CalDAV and CardDAV server, based on sabre/dav, that includes an administration interface for easy management. + +**Shipped version:** 0.9.2~ynh1 + +**Demo:** https://demo.yunohost.org/baikal/admin/ ## Screenshots -![](http://www.baikal-server.com/res/img/screenshots/dashboard.png) +![](./doc/screenshots/baikal-in-use.png) -## Demo +## Documentation and resources -* [YunoHost demo](https://demo.yunohost.org/baikal/admin/) - * Accounts: - * `demo/demo` then `admin/demo` +* Official app website: http://sabre.io/baikal/ +* Official admin documentation: https://sabre.io/dav/ +* Upstream app code repository: https://github.com/sabre-io/Baikal +* YunoHost documentation for this app: https://yunohost.org/app_baikal +* Report a bug: https://github.com/YunoHost-Apps/baikal_ynh/issues -## Configuration +## Developer info -## Documentation - - * Official documentation: http://sabre.io/baikal/ - * YunoHost documentation: https://yunohost.org/en/app_baikal - -## YunoHost specific features - -In addition to Baïkal core features, the following are made available with this package: - - * Serve `/.well-known` paths for CalDAV and CardDAV on the domain - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/baikal.svg)](https://ci-apps.yunohost.org/ci/apps/baikal/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/baikal.svg)](https://ci-apps-arm.yunohost.org/ci/apps/baikal/) - -## Limitations - -## Additional information - -* There is a breaking change in the management of the administrator password when upgrading to 0.7.0 You must change the admin password! -* To be able to change the admin password, please visit the page: `https://you.domain.tld/yunohost/admin/#/apps/baikal/actions` and set a new password. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/baikal_ynh/issues - * Baïkal website: http://baikal-server.com/ - * Upstream app repository: https://github.com/sabre-io/Baikal - * YunoHost website: https://yunohost.org/ - ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/baikal_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/baikal_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -68,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/baikal_ynh/tree/testi or sudo yunohost app upgrade baikal -u https://github.com/YunoHost-Apps/baikal_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..639aee4 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# Baïkal pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/baikal.svg)](https://dash.yunohost.org/appci/app/baikal) ![](https://ci-apps.yunohost.org/ci/badges/baikal.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/baikal.maintain.svg) +[![Installer Baïkal avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=baikal) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Baïkal 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 + +[Baïkal](http://baikal-server.com/) is a CalDAV and CardDAV server, based on sabre/dav, that includes an administration interface for easy management. + +**Version incluse :** 0.9.2~ynh1 + +**Démo :** https://demo.yunohost.org/baikal/admin/ + +## Captures d'écran + +![](./doc/screenshots/baikal-in-use.png) + +## Documentations et ressources + +* Site officiel de l'app : http://sabre.io/baikal/ +* Documentation officielle de l'admin : https://sabre.io/dav/ +* Dépôt de code officiel de l'app : https://github.com/sabre-io/Baikal +* Documentation YunoHost pour cette app : https://yunohost.org/app_baikal +* Signaler un bug : https://github.com/YunoHost-Apps/baikal_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/baikal_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/baikal_ynh/tree/testing --debug +ou +sudo yunohost app upgrade baikal -u https://github.com/YunoHost-Apps/baikal_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file