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:
parent
753982a22f
commit
98f524a138
2 changed files with 75 additions and 33 deletions
59
README.md
59
README.md
|
@ -1,56 +1,49 @@
|
|||
# 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.
|
||||
Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine
|
||||
|
||||
**Shipped version:** 0.20.0
|
||||
**Shipped version:** 1.1.0~ynh1
|
||||
|
||||
## Screenshots
|
||||
|
||||
![](movies-web-demo.gif)
|
||||
![Screenshot of MeiliSearch](./doc/screenshots/movies-web-demo.gif)
|
||||
|
||||
## Configuration
|
||||
## :red_circle: Antifeatures
|
||||
|
||||
At the installation, be sure to set up an API key to secure your API.
|
||||
- **Package not maintained**: This YunoHost package is not maintained and needs adoption.
|
||||
|
||||
## Problem and todo
|
||||
## Documentation and resources
|
||||
|
||||
- Doesn't install on subpath (WIP).
|
||||
* Official app website: <https://www.meilisearch.com/>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_meilisearch>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/meilisearch_ynh/issues>
|
||||
|
||||
#### Multi-users support
|
||||
## Developer info
|
||||
|
||||
It's an API and there is no authentification, without API key.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* 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/)
|
||||
|
||||
## 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>
|
||||
|
|
49
README_fr.md
Normal file
49
README_fr.md
Normal file
|
@ -0,0 +1,49 @@
|
|||
<!--
|
||||
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 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
|
||||
|
||||
Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine
|
||||
|
||||
**Version incluse :** 1.1.0~ynh1
|
||||
|
||||
## Captures d’écran
|
||||
|
||||
![Capture d’écran de MeiliSearch](./doc/screenshots/movies-web-demo.gif)
|
||||
|
||||
## :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 : <https://www.meilisearch.com/>
|
||||
* 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 d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
Loading…
Reference in a new issue