diff --git a/README.md b/README.md index ca8c9d7..c25bee7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # CouchDB for YunoHost -[![Integration level](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![Working status](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg) [![Install CouchDB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb) *[Lire ce readme en français.](./README_fr.md)* @@ -15,15 +15,20 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Open-source document-oriented NoSQL database +Couchdb is a database system, where entries are json objects (allowing attachments), and that you can access and synchronize via simple http requests. -**Shipped version:** 3.1.1~ynh2 +As explained in wikipedia: +> Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang. + +And as described in the couchdb official website: +> Seamless multi-master sync, that scales from Big Data to Mobile, with an Intuitive HTTP/JSON API and designed for Reliability. +**Shipped version:** 3.2.2~ynh1 ## Screenshots -![](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png) +![Screenshot of CouchDB](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png) ## Disclaimers / important information @@ -33,22 +38,23 @@ You can do most configuration of CouchDB from fauxton, the web interface, access ## Documentation and resources -* Official app website: https://couchdb.apache.org/ -* Official user documentation: https://yunohost.org/apps -* Official admin documentation: https://docs.couchdb.org/en/stable/ -* Upstream app code repository: https://github.com/apache/couchdb -* YunoHost documentation for this app: https://yunohost.org/app_couchdb -* Report a bug: https://github.com/YunoHost-Apps/couchdb_ynh/issues +* Official app website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug or sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8365b2d..e374dc8 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,25 +1,32 @@ + + # CouchDB pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg) [![Installer CouchDB avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer CouchDB 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 -Système de gestion de base de données orienté documents +Couchdb est un gestionnaire de bases de données dans lesquelles les entrées sont des documents jsons (avec possibilité de pièces jointes), qui peuvent être manipulées par de simples requêtes http. -**Version incluse :** 3.1.1~ynh2 +Comme le présente wikipédia: +> Apache CouchDB est un système de gestion de base de données orienté documents, écrit en langage Erlang et distribué sous licence Apache. +> Conçu pour le Web, il fait partie de la mouvance NoSQL, et a été conçu pour pouvoir être réparti sur une grappe de serveurs. +**Version incluse :** 3.2.2~ynh1 ## Captures d'écran -![](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png) +![Capture d'écran de CouchDB](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png) ## Avertissements / informations importantes @@ -29,22 +36,23 @@ Vous pouvez effectuer la plupart des configurations de CouchDB à partir de faux ## Documentations et ressources -* Site officiel de l'app : https://couchdb.apache.org/ -* Documentation officielle utilisateur : https://yunohost.org/apps -* Documentation officielle de l'admin : https://docs.couchdb.org/en/stable/ -* Dépôt de code officiel de l'app : https://github.com/apache/couchdb -* Documentation YunoHost pour cette app : https://yunohost.org/app_couchdb -* Signaler un bug : https://github.com/YunoHost-Apps/couchdb_ynh/issues +* Site officiel de l'app : +* Documentation officielle utilisateur : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug ou sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**