From fca48e20b2b28d97068a8a7d355c5a6fac8d9b01 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 13 Apr 2019 04:17:05 +0200 Subject: [PATCH] Apply example_ynh on ReadMe --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8fc24e4..b2db47e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,54 @@ -# syncthing_ynh +# Syncthing app for YunoHost -Only for Debian Jessie and after +[![Integration level](https://dash.yunohost.org/integration/syncthing.svg)](https://dash.yunohost.org/appci/app/syncthing) +[![Install Syncthing with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=syncthing) +> *This package allow you to install Syncthing 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.* + +## Overview +Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. + +**Shipped version:** 1.0 + +## Screenshots + +![](https://docs.syncthing.net/_images/gs1.png) + +## Configuration + +How to configure this app: by an admin panel, a plain file with SSH, or any other way. + +## Documentation + + * Official documentation: https://docs.syncthing.net + +## YunoHost specific features + +#### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/syncthing%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/syncthing/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/syncthing%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/syncthing/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/syncthing%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/syncthing/) + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/syncthing_ynh/issues + * App website: https://syncthing.net/ + * Git App website: https://github.com/syncthing/syncthing + * YunoHost website: https://yunohost.org/ + +--- + +Developers info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/syncthing_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/syncthing_ynh/tree/testing --debug +or +sudo yunohost app upgrade syncthing -u https://github.com/YunoHost-Apps/syncthing_ynh/tree/testing --debug +```