diff --git a/README.md b/README.md index 820e437..252c8e3 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,61 @@ - -# Packaging an app, starting from this example - -- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. - - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `doc/DISCLAIMER*.md` -- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator - - ---- - -# Example app for YunoHost +# Simple-Hash-Generator for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![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) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install Simple-Hash-Generator 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 -Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) +A simple hash generator utilizing a collection of popular and useful hash functions + **Shipped version:** 1.0~ynh1 -**Demo:** https://demo.example.com - +**Demo:** https://prizz.github.io/Simple-Hash-Generator/ ## Screenshots - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/example.jpg) ## Disclaimers / important information -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... +# Disclaimer -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? +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). +# About the Author +This project was originally created by Peter Ryszkiewicz ([pRizz@GitHub](https://github.com/pRizz)), software engineer in Chicago, IL. + +# About the Project + +This project is hosted on GitHub at https://github.com/pRizz/Simple-Hash-Generator under the MIT license. ## Documentation and resources -* 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://some.forge.com/example/example -* YunoHost documentation for this app: https://yunohost.org/app_example -* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Official app website: https://prizz.github.io/Simple-Hash-Generator/ +* Upstream app code repository: https://github.com/pRizz/Simple-Hash-Generator +* 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 ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade Simple-Hash-Generator -u https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index d856bf9..4505c5f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,66 +1,57 @@ -# Example app pour YunoHost +# Simple-Hash-Generator pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](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) +[![Installer Simple-Hash-Generator avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=Simple-Hash-Generator) *[Read this readme in english.](./README.md)* *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example 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.* +> *Ce package vous permet d'installer Simple-Hash-Generator 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 -Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) +A simple hash generator utilizing a collection of popular and useful hash functions -**Version incluse:** 1.0~ynh1 -**Démo:** https://demo.example.com +**Version incluse :** 1.0~ynh1 +**Démo :** https://prizz.github.io/Simple-Hash-Generator/ ## Captures d'écran - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/example.jpg) ## Avertissements / informations importantes -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... +# Disclaimer -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? +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). +# About the Author +This project was originally created by Peter Ryszkiewicz ([pRizz@GitHub](https://github.com/pRizz)), software engineer in Chicago, IL. + +# About the Project + +This project is hosted on GitHub at https://github.com/pRizz/Simple-Hash-Generator under the MIT license. ## Documentations et ressources -* Site official 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://some.forge.com/example/example -* Documentation YunoHost pour cette app: https://yunohost.org/app_example -* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Site officiel de l'app : https://prizz.github.io/Simple-Hash-Generator/ +* Dépôt de code officiel de l'app : https://github.com/pRizz/Simple-Hash-Generator +* Documentation YunoHost pour cette app : https://yunohost.org/app_Simple-Hash-Generator +* Signaler un bug : https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug -or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing --debug +ou +sudo yunohost app upgrade Simple-Hash-Generator -u https://github.com/YunoHost-Apps/Simple-Hash-Generator_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file