1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/meilisearch_ynh.git synced 2024-09-03 19:45:59 +02:00

Auto-update README

This commit is contained in:
yunohost-bot 2023-01-18 09:11:55 +00:00
parent f8156c76ee
commit 150226f738
2 changed files with 85 additions and 25 deletions

View file

@ -1,22 +1,29 @@
# Meilisearch for YunoHost
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
[![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: <https://www.meilisearch.com/>
* Upstream app code repository: <https://github.com/meilisearch/MeiliSearch>
* YunoHost documentation for this app: <https://yunohost.org/app_meilisearch>
* Report a bug: <https://github.com/YunoHost-Apps/meilisearch_ynh/issues>
* 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:** <https://yunohost.org/packaging_apps>

58
README_fr.md Normal file
View file

@ -0,0 +1,58 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# MeiliSearch pour YunoHost
[![Niveau dinté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 dinstaller MeiliSearch rapidement et simplement sur un serveur YunoHost.
Si vous navez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment linstaller et en profiter.*
## Vue densemble
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 lapp : <https://www.meilisearch.com/>
* Dépôt de code officiel de lapp : <https://github.com/meilisearch/MeiliSearch>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_meilisearch>
* Signaler un bug : <https://github.com/YunoHost-Apps/meilisearch_ynh/issues>
## 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 dinfos sur le packaging dapplications :** <https://yunohost.org/packaging_apps>