languagetool_ynh/README.md

<!--
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.
-->

# LanguageTool server for YunoHost

[![Integration level](https://dash.yunohost.org/integration/languagetool.svg)](https://dash.yunohost.org/appci/app/languagetool) ![Working status](https://ci-apps.yunohost.org/ci/badges/languagetool.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/languagetool.maintain.svg)  
[![Install LanguageTool server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=languagetool)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install LanguageTool server 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

LanguageTool is a multilingual grammar, style, and spell checker. This package provides the API server for use by other programs, like the LanguageTool extensions for browsers and word processors.


**Shipped version:** 5.7~ynh2

**Demo:** https://api.languagetool.org/

## Screenshots

![Screenshot of LanguageTool server](./doc/screenshots/screenshot_fr.png)
![Screenshot of LanguageTool server](./doc/screenshots/screenshot.png)

## Disclaimers / important information

## Configuration

There is a configuration file at `/opt/yunohost/languagetool/languagetool.conf` (for the first install).

## Documentation and resources

* Official app website: <https://languagetool.org>
* Official admin documentation: <https://dev.languagetool.org/>
* Upstream app code repository: <https://github.com/languagetool-org/languagetool>
* YunoHost documentation for this app: <https://yunohost.org/app_languagetool>
* Report a bug: <https://github.com/YunoHost-Apps/languagetool_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug
or
sudo yunohost app upgrade languagetool -u https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>