encryptor-decryptor_ynh/README.md

59 lines
2.5 KiB
Markdown
Raw Normal View History

2022-04-24 14:28:08 +02: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-04-24 14:28:17 +02:00
# Encryptor-Decryptor for YunoHost
2022-04-24 14:28:08 +02:00
2022-04-24 14:28:17 +02:00
[![Integration level](https://dash.yunohost.org/integration/encryptor-decryptor.svg)](https://dash.yunohost.org/appci/app/encryptor-decryptor) ![](https://ci-apps.yunohost.org/ci/badges/encryptor-decryptor.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptor-decryptor.maintain.svg)
[![Install Encryptor-Decryptor with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=encryptor-decryptor)
2022-04-24 14:28:08 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-04-24 14:28:17 +02:00
> *This package allows you to install Encryptor-Decryptor quickly and simply on a YunoHost server.
2022-04-24 14:28:08 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-04-24 14:28:17 +02:00
Encrypts and decrypts your files and text.
2022-04-24 14:28:08 +02:00
**Shipped version:** 1.0~ynh1
2022-04-24 14:28:17 +02:00
**Demo:** https://prizz.github.io/Easy-File-Encryptor-Decryptor/
2022-04-24 14:28:08 +02:00
## Screenshots
2022-04-24 14:28:17 +02:00
![](./doc/screenshots/.DS_Store)
![](./doc/screenshots/screenshot.png)
2022-04-24 14:28:08 +02:00
## Disclaimers / important information
# Disclaimer
2022-04-24 14:28:17 +02:00
This webapp does not store or transmit your data. But to be safe, in case of malware, or rogue browser extensions, follow these steps:
2022-04-24 14:28:08 +02:00
2022-04-24 14:28:17 +02:00
- [Download this webapp](https://github.com/pRizz/Easy-File-Encryptor-Decryptor/archive/master.zip) for offline use
- Disconnect from the internet
- Open this webapp (the index.html file) in incognito, or private browsing mode, with no extensions, or all extensions disabled
- Encrypt and Decrypt
- Quit your browser
2022-04-24 14:28:08 +02:00
## Documentation and resources
2022-04-24 14:28:17 +02:00
* Official app website: https://prizz.github.io/Easy-File-Encryptor-Decryptor/
* Upstream app code repository: https://github.com/pRizz/Easy-File-Encryptor-Decryptor
* YunoHost documentation for this app: https://yunohost.org/app_encryptor-decryptor
* Report a bug: https://github.com/YunoHost-Apps/encryptor-decryptor_ynh/issues
2022-04-24 14:28:08 +02:00
## Developer info
2022-04-24 14:28:17 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/encryptor-decryptor_ynh/tree/testing).
2022-04-24 14:28:08 +02:00
To try the testing branch, please proceed like that.
```
2022-04-24 14:28:17 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/encryptor-decryptor_ynh/tree/testing --debug
2022-04-24 14:28:08 +02:00
or
2022-04-24 14:28:17 +02:00
sudo yunohost app upgrade encryptor-decryptor -u https://github.com/YunoHost-Apps/encryptor-decryptor_ynh/tree/testing --debug
2022-04-24 14:28:08 +02:00
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps