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

# Cheky for YunoHost

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

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

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

Monitors French classifieds websites LeBonCoin and SeLoger

**Shipped version:** 4.4.1~ynh5



## Disclaimers / important information

## Features

* [Cheky](https://www.cheky.net) allows you to create various alerts for french classifieds ads website like [Leboncoin](http://leboncoin.fr/) and [SeLoger](http://www.seloger.com/).
* If you do not live in France, it will not be really useful for you

## Limitations

* No automatic update from the old package [LBCAlerte](https://github.com/YunoHost-Apps/LBCAlerte_ynh)
* Application in French only
* Does not work with SSO (separate admin / user accounts). 

## Documentation and resources

* Official app website: https://www.cheky.net
* Upstream app code repository: https://github.com/Blount/Cheky
* YunoHost documentation for this app: https://yunohost.org/app_cheky
* Report a bug: https://github.com/YunoHost-Apps/cheky_ynh/issues

## Developer info

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

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/cheky_ynh/tree/testing --debug
or
sudo yunohost app upgrade cheky -u https://github.com/YunoHost-Apps/cheky_ynh/tree/testing --debug
```

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