diff --git a/README.md b/README.md index b25ab64..f2e020b 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,47 @@ -# Duniter package for YunoHost -- [Duniter project](https://duniter.org) -- [YunoHost project](https://yunohost.org) + -## Requirements -- Debian Buster -- YunoHost ≥ v4.1 -- `x64` or `armlv7` architecture -- 200Mo free RAM -- A dedicated domain name to install the app on root path. For instance, `duniter.domain.tld`. -- A YunoHost user which will have access the web admin. +# Duniter for YunoHost -## Install and upgrade -You shall add the application community list into your instance in order to install it and benefit from upgrades: -```bash -sudo yunohost app fetchlist -n community -u https://app.yunohost.org/community.json -sudo yunohost app install duniter -sudo yunohost app upgrade duniter +[![Integration level](https://dash.yunohost.org/integration/duniter.svg)](https://dash.yunohost.org/appci/app/duniter) ![](https://ci-apps.yunohost.org/ci/badges/duniter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/duniter.maintain.svg) +[![Install Duniter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=duniter) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Duniter 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 + +Crypto-currency software to operate Ğ1 libre currency + +**Shipped version:** 1.8.1~ynh1 + +**Demo:** https://demo.example.com + +## Screenshots + +![](./doc/screenshots/duniter_admin_g1.png) + +## Documentation and resources + +* Official app website: https://duniter.org +* Official admin documentation: https://yunohost.org/packaging_apps +* Upstream app code repository: https://git.duniter.org/nodes/typescript/duniter +* YunoHost documentation for this app: https://yunohost.org/app_duniter +* Report a bug: https://github.com/YunoHost-Apps/duniter_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/duniter_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/duniter_ynh/tree/testing --debug +or +sudo yunohost app upgrade duniter -u https://github.com/YunoHost-Apps/duniter_ynh/tree/testing --debug ``` -Be carefull when installing applications from the community list. -## Configurations -- In order to compute blocks you will have to set your member credentials with `duniter wizard key` or from the webadmin. -- The BMA API is accessible from `https://duniter.domain.tld/` if enabled. -- **Warning**: In case the Webui tells you your network configuration is wrong and proposes to correct it, do not apply it, otherwise it breaks the specific configuration made for this package. -You can manually reset the configuration with following command: -`duniter config --bma --ipv4 127.0.0.1 --port CHOSEN_PORT --remoteh YOUR_DOMAIN --remotep 443 --noupnp` - -## Cesium -Cesium is a wallet webapp. You can install it with: -- [With the YunoHost app](https://github.com/YunoHost-Apps/cesium_ynh) - - -## License -This package and the Duniter software are under GNU AGPL v.3. +**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 new file mode 100644 index 0000000..350181a --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# Duniter pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/duniter.svg)](https://dash.yunohost.org/appci/app/duniter) ![](https://ci-apps.yunohost.org/ci/badges/duniter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/duniter.maintain.svg) +[![Installer Duniter avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=duniter) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Duniter 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 + +Nœud qui permet de participer à l’écriture de blocs. + +**Version incluse :** 1.8.1~ynh1 + +**Démo :** https://demo.example.com + +## Captures d'écran + +![](./doc/screenshots/duniter_admin_g1.png) + +## Documentations et ressources + +* Site officiel de l'app : https://duniter.org +* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Dépôt de code officiel de l'app : https://git.duniter.org/nodes/typescript/duniter +* Documentation YunoHost pour cette app : https://yunohost.org/app_duniter +* Signaler un bug : https://github.com/YunoHost-Apps/duniter_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/duniter_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/duniter_ynh/tree/testing --debug +ou +sudo yunohost app upgrade duniter -u https://github.com/YunoHost-Apps/duniter_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file