mirror of
https://github.com/YunoHost-Apps/snweb_ynh.git
synced 2024-09-03 20:26:22 +02:00
Update to automated README
This commit is contained in:
Fabian Wilkens
parent
5fe1f8b00a
commit
5c129ce558
6 changed files with 140 additions and 69 deletions
131
README.md
131
README.md
|
|
@ -1,77 +1,68 @@
|
|||
# Standard Notes Web App for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/snweb)
|
||||
|
||||
|
||||
|
||||
[](https://install-app.yunohost.org/?app=snweb)
|
||||
|
||||
|
||||
> *This package allow you to install snweb quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
## Overview
|
||||
Standard Notes
|
||||
|
||||
A safe and private place for your life's work.
|
||||
|
||||
Standard Notes is a simple and private notes app available on most platforms, including Web, Mac, Windows, Linux, iOS, and Android. It focuses on simplicity, and encrypts data locally before it ever touches a cloud. This means no one can read your notes but you (not even us).
|
||||
|
||||
**Shipped version:** 3.6.8
|
||||
* Apps available for free. https://standardnotes.org/
|
||||
* Desktop (Windows, Mac, Linux)
|
||||
* Mobile (Android and iOS)
|
||||
* Web https://app.standardnotes.org/
|
||||
* Self-Hosted Yunohost - Syncing Server https://github.com/YunoHost-Apps/snweb_ynh
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
Extensions, Editors, Themes: https://standardnotes.org/extensions
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
* [Official demo - Web App](https://standardnotes.org/demo)
|
||||
|
||||
## Configuration
|
||||
|
||||
How to configure this app:
|
||||
* The config-file is stored under "/opt/yunohost/$app/live/.env"
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official Help & Support: https://standardnotes.org/help
|
||||
* Official documentation: https://docs.standardnotes.org (Only delevopment documentation)
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
Are LDAP and HTTP auth supported? LDAP -> NO, HTTP auth -> Yes
|
||||
|
||||
Can the app be used by multiple users? Yes
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/snweb/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/snweb/)
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/snweb_ynh/issues
|
||||
* App website: https://standardnotes.org/
|
||||
* Upstream app repository: https://github.com/standardnotes/web
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developers info
|
||||
----------------
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/snweb_ynh/tree/testing).
|
||||
# Standard Notes for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/snweb)  
|
||||
[](https://install-app.yunohost.org/?app=snweb)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install snweb 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
|
||||
|
||||
The Standard Notes Web App. An end-to-end encrypted note-taking app. Web, Mac, Windows, Linux, iOS, and Android.
|
||||
|
||||
**Shipped version:** 3.22.8~ynh2
|
||||
|
||||
**Demo:** https://standardnotes.org/demo
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* No single-sign on or LDAP integration
|
||||
* The app requires up 1500MB of RAM to install
|
||||
* The app requires at least 80MB of RAM to work properly.
|
||||
* The app requires around 1000MB of disk.
|
||||
* A dedicated domain is requierd if you want to use extensions.
|
||||
notes.your-domain.tld/ -> Extension Manager is working
|
||||
your-domain.tld/notes/ -> Extension Manager is not working
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* The config-file is stored under "/opt/yunohost/$app/live/.env"
|
||||
* You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel
|
||||
|
||||
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: https://standardnotes.org/
|
||||
* Official user documentation: https://standardnotes.org/help
|
||||
* Official admin documentation: https://docs.standardnotes.org/
|
||||
* Upstream app code repository: https://github.com/standardnotes/web
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_snweb
|
||||
* Report a bug: https://github.com/YunoHost-Apps/snweb_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/snweb_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
|
|
@ -79,3 +70,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/snweb_ynh/tree/testin
|
|||
or
|
||||
sudo yunohost app upgrade snweb -u https://github.com/YunoHost-Apps/snweb_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
66
README_fr.md
Normal file
66
README_fr.md
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
# Standard Notes pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/snweb)  
|
||||
[](https://install-app.yunohost.org/?app=snweb)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install snweb 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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
|
||||
|
||||
**Version incluse:** 3.22.8~ynh2
|
||||
|
||||
**Démo:** https://standardnotes.org/demo
|
||||
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* No single-sign on or LDAP integration
|
||||
* The app requires up 1500MB of RAM to install
|
||||
* The app requires at least 80MB of RAM to work properly.
|
||||
* The app requires around 1000MB of disk.
|
||||
* A dedicated domain is requierd if you want to use extensions.
|
||||
notes.your-domain.tld/ -> Extension Manager is working
|
||||
your-domain.tld/notes/ -> Extension Manager is not working
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* The config-file is stored under "/opt/yunohost/$app/live/.env"
|
||||
* You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site official de l'app : https://standardnotes.org/
|
||||
* Documentation officielle utilisateur: https://standardnotes.org/help
|
||||
* Documentation officielle de l'admin: https://docs.standardnotes.org/
|
||||
* Dépôt de code officiel de l'app: https://github.com/standardnotes/web
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_snweb
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/snweb_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/snweb_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/snweb_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade snweb -u https://github.com/YunoHost-Apps/snweb_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|
||||
0
doc/.gitkeep
Normal file
0
doc/.gitkeep
Normal file
12
doc/DISCLAIMER.md
Normal file
12
doc/DISCLAIMER.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* No single-sign on or LDAP integration
|
||||
* The app requires up 1500MB of RAM to install
|
||||
* The app requires at least 80MB of RAM to work properly.
|
||||
* The app requires around 1000MB of disk.
|
||||
* A dedicated domain is requierd if you want to use extensions.
|
||||
notes.your-domain.tld/ -> Extension Manager is working
|
||||
your-domain.tld/notes/ -> Extension Manager is not working
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* The config-file is stored under "/opt/yunohost/$app/live/.env"
|
||||
* You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel
|
||||
0
doc/screenshots/.gitkeep
Normal file
0
doc/screenshots/.gitkeep
Normal file
BIN
doc/screenshots/standard_notes.png
Normal file
BIN
doc/screenshots/standard_notes.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 602 KiB |
Loading…
Add table
Reference in a new issue