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

# æneria for YunoHost

[![Integration level](https://dash.yunohost.org/integration/aeneria.svg)](https://dash.yunohost.org/appci/app/aeneria) ![Working status](https://ci-apps.yunohost.org/ci/badges/aeneria.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/aeneria.maintain.svg)

[![Install æneria with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=aeneria)

*[Read this README in other languages.](./ALL_README.md)*

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

The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to:

 * Better understand our own energy consumption
 * Analyse energy consumption throw weather data


**Shipped version:** 2.1.1~ynh1

**Demo:** <https://demo.aeneria.com>

## Screenshots

![Screenshot of æneria](./doc/screenshots/preview-1.png)
![Screenshot of æneria](./doc/screenshots/preview-2.png)
![Screenshot of æneria](./doc/screenshots/preview-3.png)

## Documentation and resources

- Official app website: <https://aeneria.com>
- Official admin documentation: <https://docs.aeneria.com>
- Upstream app code repository: <https://gitlab.com/aeneria/aeneria-app>
- YunoHost Store: <https://apps.yunohost.org/app/aeneria>
- Report a bug: <https://github.com/YunoHost-Apps/aeneria_ynh/issues>

## Developer info

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

To try the `testing` branch, please proceed like that:

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

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