From d10fe1a04e3f3234567aea60bf66c201a1fb23f1 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sat, 30 May 2020 15:45:34 +0200 Subject: [PATCH] Apply example_ynh on README --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f6c49e2..a07ee34 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,10 @@ [![Integration level](https://dash.yunohost.org/integration/lstu.svg)](https://dash.yunohost.org/appci/app/lstu) ![](https://ci-apps.yunohost.org/ci/badges/lstu.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/lstu.maintain.svg) [![Install lstu with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=lstu) -> *This package allow you to install lstu 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.* +> *This package allows you to install lstu 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 - Lstu means Let's Shorten That Url. **Shipped version:** 0.22-0 @@ -22,7 +21,7 @@ Lstu means Let's Shorten That Url. ## Configuration -How to configure this app: a plain file with SSH. +How to configure this app: a plain file at `/var/www/lstu/lstu.conf` with SSH. ## Documentation @@ -30,34 +29,32 @@ How to configure this app: a plain file with SSH. ## YunoHost specific features -#### Multi-users support +#### Multi-user support Are LDAP and HTTP auth supported? **Yes** Can the app be used by multiple users? **Yes** #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/lstu%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/lstu/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/lstu%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/lstu/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/lstu%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/lstu/) - -**More information on the documentation page:** +**More info on the documentation page:** https://yunohost.org/packaging_apps ## Links * Report a bug: https://github.com/YunoHost-Apps/lstu_ynh/issues - * App website: https://framagit.org/fiat-tux/hat-softwares/lstu + * Upstream app repository: Link to the official repository of the upstream app. * YunoHost website: https://yunohost.org/ --- -Developers info +Developer 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/lstu_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/lstu_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -65,6 +62,7 @@ sudo yunohost app install https://github.com/YunoHost-Apps/lstu_ynh/tree/testing or sudo yunohost app upgrade lstu -u https://github.com/YunoHost-Apps/lstu_ynh/tree/testing --debug ``` + ## Todo - [ ] Allow to choose the database (sqlite or PostgreSQL)