diff --git a/README.md b/README.md index 57e4249..cf44228 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,38 @@ + + # NodeBB for YunoHost [![Integration level](https://dash.yunohost.org/integration/nodebb.svg)](https://dash.yunohost.org/appci/app/nodebb) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.maintain.svg) -[![Install nodebb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodebb) +[![Install NodeBB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodebb) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install nodebb quickly and simply on a YunoHost server. +> *This package allows you to install NodeBB 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 -Quick description of this app. -**Shipped version:** 1.17.1 +Nodejs Forum + +**Shipped version:** 1.17.1~ynh1 + +**Demo:** https://try.nodebb.org ## Screenshots -![](https://i.imgur.com/Ud1LrfI.png) +![](./doc/screenshots/Ud1LrfI.png) -## Demo +## Documentation and resources -* [Official demo](Link to a demo site for this app.) - -## Configuration - -How to configure this app: From an admin panel, a plain file with SSH, or any other way. - -## Documentation - - * Official documentation: https://docs.nodebb.org/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/nodebb.svg)](https://ci-apps.yunohost.org/ci/apps/nodebb/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/nodebb.svg)](https://ci-apps-arm.yunohost.org/ci/apps/nodebb/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/nodebb_ynh/issues - * App website: https://github.com/NodeBB/NodeBB/ - * Upstream app repository: https://github.com/NodeBB/NodeBB/ - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://nodebb.org +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://docs.nodebb.org/ +* Upstream app code repository: https://github.com/NodeBB/NodeBB/ +* YunoHost documentation for this app: https://yunohost.org/app_nodebb +* Report a bug: https://github.com/YunoHost-Apps/nodebb_ynh/issues ## Developer info @@ -70,3 +45,4 @@ or sudo yunohost app upgrade nodebb -u https://github.com/YunoHost-Apps/nodebb_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..8aa2d17 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# NodeBB pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/nodebb.svg)](https://dash.yunohost.org/appci/app/nodebb) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.maintain.svg) +[![Installer NodeBB avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodebb) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer NodeBB 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 + +Forum écrit en nodejs + +**Version incluse :** 1.17.1~ynh1 + +**Démo :** https://try.nodebb.org + +## Captures d'écran + +![](./doc/screenshots/Ud1LrfI.png) + +## Documentations et ressources + +* Site officiel de l'app : https://nodebb.org +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://docs.nodebb.org/ +* Dépôt de code officiel de l'app : https://github.com/NodeBB/NodeBB/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_nodebb +* Signaler un bug : https://github.com/YunoHost-Apps/nodebb_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug +ou +sudo yunohost app upgrade nodebb -u https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file