mirror of
https://github.com/YunoHost-Apps/shaarli_ynh.git
synced 2024-09-03 20:26:10 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
5d779a6f8c
commit
685126288c
2 changed files with 101 additions and 37 deletions
74
README.md
74
README.md
|
|
@ -1,60 +1,58 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Shaarli for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/shaarli)  
|
||||
[](https://install-app.yunohost.org/?app=shaarli)
|
||||
[](https://install-app.yunohost.org/?app=shaarli)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Shaarli 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
|
||||
[Shaarli](https://github.com/shaarli/Shaarli) intends to provide YunoHost's users with a simple but advanced bookmarking service.
|
||||
|
||||
**Shipped version:** 0.12.1
|
||||
Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy.
|
||||
|
||||
### Features
|
||||
|
||||
- share, comment and save interesting links
|
||||
- bookmark useful/frequent links and share them between computers
|
||||
- a minimal blog/microblog/writing platform
|
||||
- a read-it-later/todo list
|
||||
- a notepad to draft and save articles/posts/ideas
|
||||
- a knowledge base to keep notes, documentation and code snippets
|
||||
- a shared clipboard/notepad/pastebin between computers
|
||||
- playlist manager for online media
|
||||
- feed other blogs, aggregators, social networks...
|
||||
|
||||
|
||||
**Shipped version:** 0.12.1~ynh2
|
||||
|
||||
**Demo:** https://demo.shaarli.org/
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
* [Official demo](https://demo.shaarli.org/)
|
||||
## Disclaimers / important information
|
||||
|
||||
## Configuration
|
||||
|
||||
During the installation app will prompt you to install itself as public or private, if you choose public then anyone (not just YunoHost users) would be able to access your Shaarli instance.
|
||||
|
||||
After the installation is complete, go to the domain where the Shaarli is installed and create your account. After the creation of the account the registration will be locked.
|
||||
## Documentation and resources
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://shaarli.readthedocs.io/en/master/
|
||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
||||
|
||||
## Changelog
|
||||
|
||||
For Shaarli changelog, see: https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/shaarli/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/shaarli/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Any known limitations.
|
||||
|
||||
## Additional information
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/shaarli_ynh/issues
|
||||
* App website: https://shaarli.readthedocs.io/
|
||||
* Upstream app repository: https://github.com/shaarli/Shaarli
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* Official app website: https://example.com
|
||||
* Official user documentation: https://yunohost.org/apps
|
||||
* Official admin documentation: https://yunohost.org/packaging_apps
|
||||
* Upstream app code repository: https://github.com/shaarli/Shaarli
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_shaarli
|
||||
* Report a bug: https://github.com/YunoHost-Apps/shaarli_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
|
|
@ -66,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/shaarli_ynh/tree/test
|
|||
or
|
||||
sudo yunohost app upgrade shaarli -u https://github.com/YunoHost-Apps/shaarli_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
64
README_fr.md
Normal file
64
README_fr.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# Shaarli pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/shaarli)  
|
||||
[](https://install-app.yunohost.org/?app=shaarli)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Shaarli 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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy.
|
||||
|
||||
### Features
|
||||
|
||||
- share, comment and save interesting links
|
||||
- bookmark useful/frequent links and share them between computers
|
||||
- a minimal blog/microblog/writing platform
|
||||
- a read-it-later/todo list
|
||||
- a notepad to draft and save articles/posts/ideas
|
||||
- a knowledge base to keep notes, documentation and code snippets
|
||||
- a shared clipboard/notepad/pastebin between computers
|
||||
- playlist manager for online media
|
||||
- feed other blogs, aggregators, social networks...
|
||||
|
||||
|
||||
**Version incluse :** 0.12.1~ynh2
|
||||
|
||||
**Démo :** https://demo.shaarli.org/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Configuration
|
||||
|
||||
During the installation app will prompt you to install itself as public or private, if you choose public then anyone (not just YunoHost users) would be able to access your Shaarli instance.
|
||||
|
||||
After the installation is complete, go to the domain where the Shaarli is installed and create your account. After the creation of the account the registration will be locked.
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://example.com
|
||||
* Documentation officielle utilisateur : https://yunohost.org/apps
|
||||
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps
|
||||
* Dépôt de code officiel de l'app : https://github.com/shaarli/Shaarli
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_shaarli
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/shaarli_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/shaarli_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/shaarli_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade shaarli -u https://github.com/YunoHost-Apps/shaarli_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Add table
Reference in a new issue