|
|
@@ -1,28 +1,16 @@
|
|
|
-# Packaging an app, starting from this example
|
|
|
-
|
|
|
-* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
|
|
-* Edit the `manifest.json` with app specific info.
|
|
|
-* Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`.
|
|
|
- * Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
|
|
-* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
|
|
|
-* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
|
|
|
-* Edit `doc/DISCLAIMER*.md`
|
|
|
-* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
|
-
|
|
|
----
|
|
|
<!--
|
|
|
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.
|
|
|
-->
|
|
|
|
|
|
-# Example app for YunoHost
|
|
|
+# Homarr for YunoHost
|
|
|
|
|
|
-[](https://dash.yunohost.org/appci/app/example)  
|
|
|
-[](https://install-app.yunohost.org/?app=example)
|
|
|
+[](https://dash.yunohost.org/appci/app/homarr)  
|
|
|
+[](https://install-app.yunohost.org/?app=homarr)
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
-> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
|
|
+> *This package allows you to install Homarr 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
|
|
|
@@ -38,13 +26,13 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
|
|
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
|
|
|
|
|
|
|
|
-**Shipped version:** 1.0~ynh1
|
|
|
+**Shipped version:** 0.10.7~ynh1
|
|
|
|
|
|
**Demo:** https://demo.example.com
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
|
|
@@ -63,23 +51,23 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
|
|
-* Official app website: <https://example.com>
|
|
|
+* Official app website: <https://homarr.dev/>
|
|
|
* Official user documentation: <https://yunohost.org/apps>
|
|
|
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
|
|
-* Upstream app code repository: <https://some.forge.com/example/example>
|
|
|
-* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
|
|
-* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
|
|
+* Upstream app code repository: <https://github.com/ajnart/homarr>
|
|
|
+* YunoHost documentation for this app: <https://yunohost.org/app_homarr>
|
|
|
+* Report a bug: <https://github.com/YunoHost-Apps/homarr_ynh/issues>
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
|
|
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/homarr_ynh/tree/testing).
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
|
``` bash
|
|
|
-sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
|
|
or
|
|
|
-sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
|
|
+sudo yunohost app upgrade homarr -u https://github.com/YunoHost-Apps/homarr_ynh/tree/testing --debug
|
|
|
```
|
|
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|