1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/shiori_ynh.git synced 2024-09-03 20:26:17 +02:00
shiori_ynh/README.md

70 lines
3.1 KiB
Markdown
Raw Normal View History

2022-01-10 15:18:34 +01:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-01-10 15:18:41 +01:00
# Shiori for YunoHost
2022-01-10 15:18:34 +01:00
2023-02-03 18:31:23 +01:00
[![Integration level](https://dash.yunohost.org/integration/shiori.svg)](https://dash.yunohost.org/appci/app/shiori) ![Working status](https://ci-apps.yunohost.org/ci/badges/shiori.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/shiori.maintain.svg)
2022-01-10 15:18:41 +01:00
[![Install Shiori with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shiori)
2022-01-10 15:18:34 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2022-01-10 15:18:41 +01:00
> *This package allows you to install Shiori quickly and simply on a YunoHost server.
2022-01-10 15:18:34 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-01-10 15:25:33 +01:00
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.
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
### Features
2022-01-10 15:18:34 +01:00
2022-01-10 15:25:33 +01:00
- Simple and clean command line interface.
- Basic bookmarks management i.e. add, edit and delete.
2022-01-12 08:56:19 +01:00
- Search bookmarks by their title, tags, URL and page content.
2022-01-10 15:25:33 +01:00
- 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.
2022-01-10 15:18:34 +01:00
2023-02-03 18:32:24 +01:00
**Shipped version:** 1.5.3~ynh6
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
## Screenshots
2022-01-10 15:18:34 +01:00
2022-05-31 22:42:56 +02:00
![Screenshot of Shiori](./doc/screenshots/screenshot.png)
2022-01-10 15:18:34 +01:00
## Disclaimers / important information
2022-06-16 08:27:21 +02:00
### First log in
2022-01-12 10:18:39 +01:00
The default account is `shiori` with password `gopher`. It is removed once another 'owner' account is created.
2022-01-12 08:59:16 +01:00
2022-01-10 18:01:04 +01:00
- username: `shiori`
- password: `gopher`
2022-01-10 15:18:34 +01:00
2023-02-03 18:31:23 +01:00
### Shiori Web Extension
[Shiori Web Extension](https://github.com/go-shiori/shiori-web-ext) is a simple extension for managing bookmarks using Shiori. This extension is intended to integrate Shiori with your favorite web browser. This way, you can save and remove bookmarks in Shiori without switching from your current page.
2022-01-10 15:18:34 +01:00
## Documentation and resources
2022-05-31 22:42:56 +02:00
* 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>
2022-01-10 15:18:34 +01:00
## Developer info
2022-01-10 15:18:41 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing).
2022-01-10 15:18:34 +01:00
To try the testing branch, please proceed like that.
2022-05-31 22:42:56 +02:00
``` bash
2022-01-10 15:18:41 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
2022-01-10 15:18:34 +01:00
or
2022-01-10 15:18:41 +01:00
sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
2022-01-10 15:18:34 +01:00
```
2022-05-31 22:42:56 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>