diff --git a/README.md b/README.md index 4b225f5..ad9ca7e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # TrustyHash for YunoHost -[![Integration level](https://dash.yunohost.org/integration/trustyhash.svg)](https://dash.yunohost.org/appci/app/trustyhash) ![](https://ci-apps.yunohost.org/ci/badges/trustyhash.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/trustyhash.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/trustyhash.svg)](https://dash.yunohost.org/appci/app/trustyhash) ![Working status](https://ci-apps.yunohost.org/ci/badges/trustyhash.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/trustyhash.maintain.svg) [![Install TrustyHash with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trustyhash) *[Lire ce readme en français.](./README_fr.md)* @@ -15,61 +15,11 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -# TrustyHash - A Trustable Hash Calculator - TrustyHash is a small [client-side](https://unhosted.org/) web application that computes SHA-256 hash values on both local files and on remote URLs, with a strong emphasis on a process that will allow you to trust the results. Works offline! -TrustyHash homepage: https://github.com/sprin/TrustyHash - -[Use it here](https://sprin.github.io/TrustyHash/) - -## How is this useful? - -Integrity: "We have in hand the same set of sequences of bits that came into -existence when the object was created" - [Lynch](http://www.clir.org/pubs/reports/pub92/lynch.html) - -"Friends don't let friends use unverified downloads." - -This fills a need for a verifiable, web-based hash calculator written in free -JavaScript. If you already use the command-line hash utilities on your -system, you should continue to use those. This is targeted towards users who do -not have or are unable to use the hash utilities on their local systems. While -universal command-line-literacy is a good goal, the concepts of file integrity and -authenticity and the ability to use tools for verification are perhaps more -fundamental. - -Integrity is the first link in secure systems, and key to determining -authenticity. If we trust the association between an author and the hash value -of a file they created, perhaps because we trust them and they gave us the -hash in person, we can authenticate whether a file we believe to be the same -really did come from them. We can achieve the same result if the author had -used a signing key, and signed and distributed a hash value along with the -file, and we could trust the association between a particular key and the -author - albeit with somewhat more complexity and caveats (eg, has the signing -key been kept private?). - -In a few words, this tool aims to enable verification of integrity and -authenticity claims in an accessible way that depends only on a trusted hash -value and the correctness and integrity of the TrustyHash app and the browser -it executes in. See the section "Trust" below for recommendations on -how to verify integrity of this application. - -## Usage - -Local files can be opened from a file select dialog, or dragged into the "drop -area". Remote URLs can be entered, and if the remote server allows cross-origin -GET requests via -[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS), -the file will be downloaded to the browser, with the option of saving locally. - -It's recommended to save the application, verify the integrity, and use the -saved copy from then on. To save from the browser, use "Save Page" > "Web Page, -HTML Only", and use a filename of `TrustyHash.html`. To verify, read the -section on "Trust" below. - **Shipped version:** 1.0~ynh1 @@ -77,7 +27,7 @@ section on "Trust" below. ## Screenshots -![](./doc/screenshots/example.jpg) +![Screenshot of TrustyHash](./doc/screenshots/example.jpg) ## Disclaimers / important information @@ -370,21 +320,22 @@ the browser, as recommended anyway. ## Documentation and resources -* Official app website: https://github.com/sprin/TrustyHash -* Official user documentation: https://github.com/sprin/TrustyHash -* Upstream app code repository: https://github.com/sprin/TrustyHash -* YunoHost documentation for this app: https://yunohost.org/app_trustyhash -* Report a bug: https://github.com/YunoHost-Apps/trustyhash_ynh/issues +* Official app website: +* Official user documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/trustyhash_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/trustyhash_ynh/tree/testing --debug or sudo yunohost app upgrade trustyhash -u https://github.com/YunoHost-Apps/trustyhash_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 0265f4b..169081a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,71 +1,25 @@ + + # TrustyHash pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/trustyhash.svg)](https://dash.yunohost.org/appci/app/trustyhash) ![](https://ci-apps.yunohost.org/ci/badges/trustyhash.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/trustyhash.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/trustyhash.svg)](https://dash.yunohost.org/appci/app/trustyhash) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/trustyhash.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/trustyhash.maintain.svg) [![Installer TrustyHash avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=trustyhash) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer TrustyHash 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 -# TrustyHash - A Trustable Hash Calculator - TrustyHash is a small [client-side](https://unhosted.org/) web application that computes SHA-256 hash values on both local files and on remote URLs, with a strong emphasis on a process that will allow you to trust the results. Works offline! -TrustyHash homepage: https://github.com/sprin/TrustyHash - -[Use it here](https://sprin.github.io/TrustyHash/) - -## How is this useful? - -Integrity: "We have in hand the same set of sequences of bits that came into -existence when the object was created" - [Lynch](http://www.clir.org/pubs/reports/pub92/lynch.html) - -"Friends don't let friends use unverified downloads." - -This fills a need for a verifiable, web-based hash calculator written in free -JavaScript. If you already use the command-line hash utilities on your -system, you should continue to use those. This is targeted towards users who do -not have or are unable to use the hash utilities on their local systems. While -universal command-line-literacy is a good goal, the concepts of file integrity and -authenticity and the ability to use tools for verification are perhaps more -fundamental. - -Integrity is the first link in secure systems, and key to determining -authenticity. If we trust the association between an author and the hash value -of a file they created, perhaps because we trust them and they gave us the -hash in person, we can authenticate whether a file we believe to be the same -really did come from them. We can achieve the same result if the author had -used a signing key, and signed and distributed a hash value along with the -file, and we could trust the association between a particular key and the -author - albeit with somewhat more complexity and caveats (eg, has the signing -key been kept private?). - -In a few words, this tool aims to enable verification of integrity and -authenticity claims in an accessible way that depends only on a trusted hash -value and the correctness and integrity of the TrustyHash app and the browser -it executes in. See the section "Trust" below for recommendations on -how to verify integrity of this application. - -## Usage - -Local files can be opened from a file select dialog, or dragged into the "drop -area". Remote URLs can be entered, and if the remote server allows cross-origin -GET requests via -[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS), -the file will be downloaded to the browser, with the option of saving locally. - -It's recommended to save the application, verify the integrity, and use the -saved copy from then on. To save from the browser, use "Save Page" > "Web Page, -HTML Only", and use a filename of `TrustyHash.html`. To verify, read the -section on "Trust" below. - **Version incluse :** 1.0~ynh1 @@ -73,7 +27,7 @@ section on "Trust" below. ## Captures d'écran -![](./doc/screenshots/example.jpg) +![Capture d'écran de TrustyHash](./doc/screenshots/example.jpg) ## Avertissements / informations importantes @@ -366,21 +320,22 @@ the browser, as recommended anyway. ## Documentations et ressources -* Site officiel de l'app : https://github.com/sprin/TrustyHash -* Documentation officielle utilisateur : https://github.com/sprin/TrustyHash -* Dépôt de code officiel de l'app : https://github.com/sprin/TrustyHash -* Documentation YunoHost pour cette app : https://yunohost.org/app_trustyhash -* Signaler un bug : https://github.com/YunoHost-Apps/trustyhash_ynh/issues +* Site officiel de l'app : +* Documentation officielle utilisateur : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/trustyhash_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/trustyhash_ynh/tree/testing --debug ou sudo yunohost app upgrade trustyhash -u https://github.com/YunoHost-Apps/trustyhash_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 :**