simple-hash-generator_ynh/README.md

61 lines
2.8 KiB
Markdown
Raw Normal View History

2022-04-23 15:11:56 +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-23 18:12:10 +02:00
# Simple-Hash-Generator for YunoHost
2022-04-23 15:11:56 +02:00
2022-04-24 13:19:32 +02:00
[![Integration level](https://dash.yunohost.org/integration/simple-hash-generator.svg)](https://dash.yunohost.org/appci/app/simple-hash-generator) ![](https://ci-apps.yunohost.org/ci/badges/simple-hash-generator.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/simple-hash-generator.maintain.svg)
[![Install Simple-Hash-Generator with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=simple-hash-generator)
2022-04-23 15:11:56 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-04-23 18:12:10 +02:00
> *This package allows you to install Simple-Hash-Generator quickly and simply on a YunoHost server.
2022-04-23 15:11:56 +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-23 18:12:10 +02:00
A simple hash generator utilizing a collection of popular and useful hash functions
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
**Shipped version:** 1.0~ynh1
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
**Demo:** https://prizz.github.io/Simple-Hash-Generator/
2022-04-23 15:11:56 +02:00
## Screenshots
2022-04-23 18:12:10 +02:00
![](./doc/screenshots/example.jpg)
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
## Disclaimers / important information
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
# Disclaimer
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
All hashing is done directly in the browser. Your data is not sent to any server, ever. If you are skeptical, which I respect, I recommend [downloading the latest release here](https://github.com/pRizz/Simple-Hash-Generator/releases), turning off your internet, unzip the release, open index.html, check out the network debugger, and see that hashing still works. Or if you are a developer, you can audit the [source code here](https://github.com/pRizz/Simple-Hash-Generator).
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
# About the Author
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
This project was originally created by Peter Ryszkiewicz ([pRizz@GitHub](https://github.com/pRizz)), software engineer in Chicago, IL.
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
# About the Project
2022-04-23 15:11:56 +02:00
2022-04-23 18:12:10 +02:00
This project is hosted on GitHub at https://github.com/pRizz/Simple-Hash-Generator under the MIT license.
2022-04-23 15:11:56 +02:00
## Documentation and resources
2022-04-23 18:12:10 +02:00
* Official app website: https://prizz.github.io/Simple-Hash-Generator/
* Upstream app code repository: https://github.com/pRizz/Simple-Hash-Generator
2022-04-24 13:19:32 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_simple-hash-generator
* Report a bug: https://github.com/YunoHost-Apps/simple-hash-generator_ynh/issues
2022-04-23 15:11:56 +02:00
## Developer info
2022-04-24 13:19:32 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/simple-hash-generator_ynh/tree/testing).
2022-04-23 15:11:56 +02:00
To try the testing branch, please proceed like that.
```
2022-04-24 13:19:32 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/simple-hash-generator_ynh/tree/testing --debug
2022-04-23 15:11:56 +02:00
or
2022-04-24 13:19:32 +02:00
sudo yunohost app upgrade simple-hash-generator -u https://github.com/YunoHost-Apps/simple-hash-generator_ynh/tree/testing --debug
2022-04-23 15:11:56 +02:00
```
2022-04-23 18:12:10 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps