diff --git a/README.md b/README.md index dffea9a..dd071fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Nullboard for YunoHost [![Integration level](https://dash.yunohost.org/integration/nullboard.svg)](https://dash.yunohost.org/appci/app/nullboard) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.maintain.svg) @@ -5,54 +10,37 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Nullboard 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.* +> *This package allows you to install Nullboard 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 -Nullboard is a minimalist take on a kanban board / a task list manager, designed to be compact, readable and quick in use. +Minimalist kanban board, focused on compactness and readability + +**Shipped version:** 1.0~ynh3 + +**Demo:** https://nullboard.io/preview ## Screenshots -![](https://camo.githubusercontent.com/700edd0af42b2fe7ca91961691d856e05bd1d9aeb7966b1da2478d7ccce863a5/68747470733a2f2f6e756c6c626f6172642e696f2f696d616765732f6e756c6c626f6172642d6578616d706c652d616c742e706e673f7a) +![](./doc/screenshots/screenshot.png) -## Demo - -* [Official demo](https://nullboard.io/preview) - -## Documentation - - * Official documentation: https://nullboard.io/preview - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### 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/nullboard.svg)](https://ci-apps.yunohost.org/ci/apps/nullboard/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/nullboard.svg)](https://ci-apps-arm.yunohost.org/ci/apps/nullboard/) +## Disclaimers / important information ## Limitations * :warning: Uses localStorage for storing boards/lists/notes, so be careful around clearing your cache. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/nullboard_ynh/issues - * App website: https://nullboard.io/preview - * Upstream app repository: https://github.com/apankrat/nullboard - * YunoHost website: https://yunohost.org/ +* Official app website: https://nullboard.io/ +* Upstream app code repository: https://github.com/apankrat/nullboard +* YunoHost documentation for this app: https://yunohost.org/app_nullboard +* Report a bug: https://github.com/YunoHost-Apps/nullboard_ynh/issues ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/nullboard_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nullboard_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -60,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/nullboard_ynh/tree/te or sudo yunohost app upgrade nullboard -u https://github.com/YunoHost-Apps/nullboard_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 index 700f671..d9e3a9c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,54 +1,38 @@ # Nullboard pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/nullboard.svg)](https://dash.yunohost.org/appci/app/nullboard) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/nullboard.svg)](https://dash.yunohost.org/appci/app/nullboard) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nullboard.maintain.svg) [![Installer Nullboard avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nullboard) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d’installer Nullboard 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.* +> *Ce package vous permet d'installer Nullboard 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 +## Vue d'ensemble -Nullboard est une version minimaliste d'un tableau Kanban/gestionnaire de liste de tâches, conçu pour être compact, lisible et rapide à utiliser. +Kanban minimaliste, axé sur la compacité et la lisibilité -## Captures d’écran +**Version incluse :** 1.0~ynh3 -![](https://camo.githubusercontent.com/700edd0af42b2fe7ca91961691d856e05bd1d9aeb7966b1da2478d7ccce863a5/68747470733a2f2f6e756c6c626f6172642e696f2f696d616765732f6e756c6c626f6172642d6578616d706c652d616c742e706e673f7a) +**Démo :** https://nullboard.io/preview -## Démo +## Captures d'écran -* [Démo officielle](https://nullboard.io/preview) +![](./doc/screenshots/screenshot.png) -## Documentation - - * Documentation officielle : https://nullboard.io/preview - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/nullboard.svg)](https://ci-apps.yunohost.org/ci/apps/nullboard/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/nullboard.svg)](https://ci-apps-arm.yunohost.org/ci/apps/nullboard/) +## Avertissements / informations importantes ## Limitations * :warning: Utilise localStorage pour stocker les tableaux/listes/notes, soyez prudent lorsque vous effacez votre cache. -## Liens +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/nullboard_ynh/issues - * Site de l'application : https://nullboard.io/preview - * Dépôt de l’application principale : https://github.com/apankrat/nullboard - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://nullboard.io/ +* Dépôt de code officiel de l'app : https://github.com/apankrat/nullboard +* Documentation YunoHost pour cette app : https://yunohost.org/app_nullboard +* Signaler un bug : https://github.com/YunoHost-Apps/nullboard_ynh/issues ## Informations pour les développeurs @@ -60,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/nullboard_ynh/tree/te ou sudo yunohost app upgrade nullboard -u https://github.com/YunoHost-Apps/nullboard_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file