diff --git a/README.md b/README.md index 126561a..ef34935 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,29 @@ -# Meilisearch for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/meilisearch.svg)](https://dash.yunohost.org/appci/app/meilisearch) ![](https://ci-apps.yunohost.org/ci/badges/meilisearch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/meilisearch.maintain.svg) -[![Install Meilisearch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=meilisearch) +# MeiliSearch for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/meilisearch.svg)](https://dash.yunohost.org/appci/app/meilisearch) ![Working status](https://ci-apps.yunohost.org/ci/badges/meilisearch.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/meilisearch.maintain.svg) +[![Install MeiliSearch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=meilisearch) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Meilisearch 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 MeiliSearch 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 Meilisearch is an opensource next generation search API. -**Shipped version:** 0.20.0 +**Shipped version:** 0.22.0~ynh1 ## Screenshots -![](movies-web-demo.gif) +![Screenshot of MeiliSearch](./doc/screenshots/movies-web-demo.gif) + +## Disclaimers / important information ## Configuration @@ -25,32 +32,27 @@ At the installation, be sure to set up an API key to secure your API. ## Problem and todo - Doesn't install on subpath (WIP). +## :red_circle: Antifeatures -#### Multi-users support +- **Package not maintained**: This YunoHost package is not maintained and needs adoption. -It's an API and there is no authentification, without API key. +## Documentation and resources -#### Supported architectures +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/meilisearch.svg)](https://ci-apps.yunohost.org/ci/apps/meilisearch/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/meilisearch.svg)](https://ci-apps-arm.yunohost.org/ci/apps/meilisearch/) +## Developer info -## Links - - * Report a bug: https://github.com/YunoHost-Apps/meilisearch_ynh/issues - * App website: https://www.meilisearch.com/ - * Upstream app repository: https://github.com/meilisearch/MeiliSearch - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug or sudo yunohost app upgrade meilisearch -u https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..1106c89 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,58 @@ + + +# MeiliSearch pour YunoHost + +[![Niveau d’intégration](https://dash.yunohost.org/integration/meilisearch.svg)](https://dash.yunohost.org/appci/app/meilisearch) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/meilisearch.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/meilisearch.maintain.svg) +[![Installer MeiliSearch avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=meilisearch) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d’installer MeiliSearch 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 + +Meilisearch is an opensource next generation search API. + +**Version incluse :** 0.22.0~ynh1 + +## Captures d’écran + +![Capture d’écran de MeiliSearch](./doc/screenshots/movies-web-demo.gif) + +## Avertissements / informations importantes + +## Configuration + +At the installation, be sure to set up an API key to secure your API. + +## Problem and todo + +- Doesn't install on subpath (WIP). +## :red_circle: Fonctions indésirables + +- **Package not maintained**: This YunoHost package is not maintained and needs adoption. + +## Documentations et ressources + +* Site officiel de l’app : +* 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/meilisearch_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug +ou +sudo yunohost app upgrade meilisearch -u https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug +``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file