diff --git a/README.md b/README.md index ad85e79..64cd691 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,18 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. +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 -- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; -- Laboris nisi ut aliquip ex ea commodo consequat ; -- Duis aute irure dolor in reprehenderit in voluptate ; -- Velit esse cillum dolore eu fugiat nulla pariatur ; -- Excepteur sint occaecat cupidatat non proident, sunt in culpa." +- 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. +- Portable, thanks to its single binary format and sqlite3 database +- 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.5.0~ynh1 @@ -32,7 +35,7 @@ Some long and extensive description of what the app is and does, lorem ipsum dol ## Screenshots -![](./doc/screenshots/example.jpg) +![](./doc/screenshots/screenshot.png) ## Disclaimers / important information @@ -52,7 +55,8 @@ 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 admin documentation: https://yunohost.org/packaging_apps +* Official user documentation: https://github.com/go-shiori/shiori/wiki/Usage +* Official admin documentation: https://github.com/go-shiori/shiori/wiki * Upstream app code repository: https://github.com/go-shiori/shiori * YunoHost documentation for this app: https://yunohost.org/app_shiori * Report a bug: https://github.com/YunoHost-Apps/shiori_ynh/issues diff --git a/README_fr.md b/README_fr.md index abfcef7..137e1bd 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,15 +11,18 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour ## Vue d'ensemble -Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. +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 -- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; -- Laboris nisi ut aliquip ex ea commodo consequat ; -- Duis aute irure dolor in reprehenderit in voluptate ; -- Velit esse cillum dolore eu fugiat nulla pariatur ; -- Excepteur sint occaecat cupidatat non proident, sunt in culpa." +- 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. +- Portable, thanks to its single binary format and sqlite3 database +- 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. + **Version incluse :** 1.5.0~ynh1 @@ -28,7 +31,7 @@ Some long and extensive description of what the app is and does, lorem ipsum dol ## Captures d'écran -![](./doc/screenshots/example.jpg) +![](./doc/screenshots/screenshot.png) ## Avertissements / informations importantes @@ -48,7 +51,8 @@ Some long and extensive description of what the app is and does, lorem ipsum dol ## Documentations et ressources * Site officiel de l'app : https://example.com -* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Documentation officielle utilisateur : https://github.com/go-shiori/shiori/wiki/Usage +* Documentation officielle de l'admin : https://github.com/go-shiori/shiori/wiki * Dépôt de code officiel de l'app : https://github.com/go-shiori/shiori * Documentation YunoHost pour cette app : https://yunohost.org/app_shiori * Signaler un bug : https://github.com/YunoHost-Apps/shiori_ynh/issues