diff --git a/README.md b/README.md index f3c3510..6fed421 100755 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -The definitive self-hosted URL shortener +Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it. + +Additionally, there's also an official Shlink web client which, by making use of Shlink's REST API, provides a beautiful web UI to handle multiple Shlink instances. **Shipped version:** 3.1.2~ynh1 @@ -23,21 +25,6 @@ The definitive self-hosted URL shortener ![Screenshot of Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg) -## Disclaimers / important information - -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... - -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 87166c8..6885b3b 100755 --- a/README_fr.md +++ b/README_fr.md @@ -15,7 +15,9 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -The definitive self-hosted URL shortener +Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it. + +Additionally, there's also an official Shlink web client which, by making use of Shlink's REST API, provides a beautiful web UI to handle multiple Shlink instances. **Version incluse :** 3.1.2~ynh1 @@ -23,21 +25,6 @@ The definitive self-hosted URL shortener ![Capture d'écran de Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg) -## Avertissements / informations importantes - -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... - -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? - ## Documentations et ressources * Site officiel de l'app :