diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index 3a67312..09005bf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Shiori with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shiori) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Shiori 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.* +> *This package allows you to install Shiori 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 @@ -27,7 +27,8 @@ Shiori is a simple bookmarks manager written in Go language. Intended as a simpl - Simple web interface for those who don't want to use a command line app. - Where possible, by default shiori will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page. -**Shipped version:** 1.6.0~ynh1 + +**Shipped version:** 1.6.1~ynh1 ## Screenshots @@ -43,9 +44,9 @@ Shiori is a simple bookmarks manager written in Go language. Intended as a simpl ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 8481af3..844ca31 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Shiori pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Shiori avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shiori) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Shiori rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d’installer Shiori rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -27,7 +27,8 @@ Shiori est un simple gestionnaire de signets écrit en langage Go. Conçu comme - Interface Web simple pour ceux qui ne veulent pas utiliser une application en ligne de commande. - Dans la mesure du possible, shiori téléchargera par défaut une copie statique de la page Web au format texte simple et HTML, qui pourra ensuite être utilisée comme archive hors ligne pour cette page. -**Version incluse :** 1.6.0~ynh1 + +**Version incluse :** 1.6.1~ynh1 ## Captures d’écran @@ -35,17 +36,17 @@ Shiori est un simple gestionnaire de signets écrit en langage Go. Conçu comme ## Documentations et ressources -- Documentation officielle utilisateur : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug @@ -53,4 +54,4 @@ ou sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..d85e937 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,57 @@ + + +# Shiori para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/shiori.svg)](https://dash.yunohost.org/appci/app/shiori) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/shiori.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/shiori.maintain.svg) + +[![Instalar Shiori con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shiori) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Shiori de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +Shiori is a simple bookmarks manager written in Go language. Intended as a simple clone of Pocket. You can use it as command line application or as web application. This application is distributed as a single binary, which means it can be installed and used easily. + +### Features + +- Simple and clean command line interface. +- Basic bookmarks management i.e. add, edit and delete. +- Search bookmarks by their title, tags, URL and page content. +- Import and export bookmarks from and to Netscape Bookmark file. +- Simple web interface for those who don't want to use a command line app. +- Where possible, by default shiori will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page. + + +**Versión proporcionada:** 1.6.1~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Shiori](./doc/screenshots/screenshot.png) + +## Documentación e recursos + +- Documentación oficial para usuarias: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug +ou +sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..b6df590 --- /dev/null +++ b/README_it.md @@ -0,0 +1,57 @@ + + +# Shiori per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/shiori.svg)](https://dash.yunohost.org/appci/app/shiori) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/shiori.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/shiori.maintain.svg) + +[![Installa Shiori con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shiori) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Shiori su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +Shiori is a simple bookmarks manager written in Go language. Intended as a simple clone of Pocket. You can use it as command line application or as web application. This application is distributed as a single binary, which means it can be installed and used easily. + +### Features + +- Simple and clean command line interface. +- Basic bookmarks management i.e. add, edit and delete. +- Search bookmarks by their title, tags, URL and page content. +- Import and export bookmarks from and to Netscape Bookmark file. +- Simple web interface for those who don't want to use a command line app. +- Where possible, by default shiori will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page. + + +**Versione pubblicata:** 1.6.1~ynh1 + +## Screenshot + +![Screenshot di Shiori](./doc/screenshots/screenshot.png) + +## Documentazione e risorse + +- Documentazione ufficiale per gli utenti: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug +o +sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**