diff --git a/README.md b/README.md index 7d726d4..7728593 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,47 @@ -pgAdmin for yunohost -==================== + + +# pgAdmin for YunoHost [![Integration level](https://dash.yunohost.org/integration/pgadmin.svg)](https://dash.yunohost.org/appci/app/pgadmin) ![](https://ci-apps.yunohost.org/ci/badges/pgadmin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pgadmin.maintain.svg) -[![Install pgadmin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pgadmin) +[![Install pgAdmin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pgadmin) -> *This package allow you to install pgadmin 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)* -Overview --------- +> *This package allows you to install pgAdmin 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 pgAdmin is a feature rich Open Source administration and development platform for PostgreSQL. -**Shipped version:** 4-5.7 -Screenshots ------------ +**Shipped version:** 4-5.7~ynh1 -![](https://www.pgadmin.org/static/COMPILED/assets/img/screenshots/pgadmin4-welcome-light.png) -Documentation -------------- - * Official documentation: https://www.pgadmin.org/docs/ - * YunoHost documentation: There no other documentations, feel free to contribute. +## Screenshots -YunoHost specific features --------------------------- +![](./doc/screenshots/pgadmin4-welcome-light.png) + +## Disclaimers / important information ### Multi-users support This app actually don't support the SSO and don't support LDAP. After the install of the app you can create a other user. So this app is multi-users but independently of the LDAP database. -### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pgadmin%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pgadmin/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pgadmin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pgadmin/) +* Official app website: https://www.pgadmin.org +* Official admin documentation: https://www.pgadmin.org/docs +* YunoHost documentation for this app: https://yunohost.org/app_pgadmin +* Report a bug: https://github.com/YunoHost-Apps/pgadmin_ynh/issues - - - - -Links ------ - - * Report a bug: https://github.com/YunoHost-Apps/pgadmin_ynh/issues - * App website: https://www.pgadmin.org/ - * YunoHost website: https://yunohost.org/ - ---- - -Install -------- - -From command line: - -`sudo yunohost app install -l pgAdmin https://github.com/YunoHost-Apps/pgadmin_ynh` - -Upgrade -------- - -From command line: - -`sudo yunohost app upgrade pgadmin -u https://github.com/YunoHost-Apps/pgadmin_ynh` - -Developers infos ----------------- - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -82,12 +50,4 @@ or sudo yunohost app upgrade pgadmin -u https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing --debug ``` -License -------- - -pgAdmin is published under the the PostgreSQL licence : https://www.pgadmin.org/licence/ - -TODO ----- - -- Add sso auth +**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..72c174c --- /dev/null +++ b/README_fr.md @@ -0,0 +1,49 @@ +# pgAdmin pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pgadmin.svg)](https://dash.yunohost.org/appci/app/pgadmin) ![](https://ci-apps.yunohost.org/ci/badges/pgadmin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pgadmin.maintain.svg) +[![Installer pgAdmin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pgadmin) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer pgAdmin 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 + +pgAdmin is a feature rich Open Source administration and development platform for PostgreSQL. + + +**Version incluse :** 4-5.7~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/pgadmin4-welcome-light.png) + +## Avertissements / informations importantes + +### Multi-users support + +This app actually don't support the SSO and don't support LDAP. After the install of the app you can create a other user. So this app is multi-users but independently of the LDAP database. + +## Documentations et ressources + +* Site officiel de l'app : https://www.pgadmin.org +* Documentation officielle de l'admin : https://www.pgadmin.org/docs +* Documentation YunoHost pour cette app : https://yunohost.org/app_pgadmin +* Signaler un bug : https://github.com/YunoHost-Apps/pgadmin_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pgadmin -u https://github.com/YunoHost-Apps/pgadmin_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file