diff --git a/README.md b/README.md index 75433a2..c7bbc73 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,21 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Firefly III Data Importer, the nr. 1 tool to import data into Firefly III. +Firefly III Data Importer is the nr. 1 tool to import data into [Firefly III](https://www.firefly-iii.org/). This tools helps you import transactions from files or bank APIs into your +Firefly-III server. Please follow the documentation at https://docs.firefly-iii.org/data-importer/. + +If your Firefly-III server is installed as a YunoHost app, please note: + +- It should be accessible to all visitors (using its internal user management instead of YunoHosts') for the Data Importer to communicate with it. + +- When configuring the Data Importer, use the public Firefly-III domain and path, not *localhost*, even if both services are on the same machine. **Shipped version:** 1.2.1~ynh1 ## Screenshots -![Screenshot of Firefly III Importer](./doc/screenshots/imac-complete.png) +![Screenshot of Firefly III Importer](./doc/screenshots/firefly-iii-di-start-screen.png) ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index f148e7a..8009841 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,14 +16,21 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Firefly III Data Importer, the nr. 1 tool to import data into Firefly III. +Firefly III Data Importer is the nr. 1 tool to import data into [Firefly III](https://www.firefly-iii.org/). This tools helps you import transactions from files or bank APIs into your +Firefly-III server. Please follow the documentation at https://docs.firefly-iii.org/data-importer/. + +If your Firefly-III server is installed as a YunoHost app, please note: + +- It should be accessible to all visitors (using its internal user management instead of YunoHosts') for the Data Importer to communicate with it. + +- When configuring the Data Importer, use the public Firefly-III domain and path, not *localhost*, even if both services are on the same machine. **Version incluse :** 1.2.1~ynh1 ## Captures d’écran -![Capture d’écran de Firefly III Importer](./doc/screenshots/imac-complete.png) +![Capture d’écran de Firefly III Importer](./doc/screenshots/firefly-iii-di-start-screen.png) ## Documentations et ressources diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index a3af9a7..791dc25 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1,8 @@ -Firefly III Data Importer, the nr. 1 tool to import data into Firefly III. +Firefly III Data Importer is the nr. 1 tool to import data into [Firefly III](https://www.firefly-iii.org/). This tools helps you import transactions from files or bank APIs into your +Firefly-III server. Please follow the documentation at https://docs.firefly-iii.org/data-importer/. + +If your Firefly-III server is installed as a YunoHost app, please note: + +- It should be accessible to all visitors (using its internal user management instead of YunoHosts') for the Data Importer to communicate with it. + +- When configuring the Data Importer, use the public Firefly-III domain and path, not *localhost*, even if both services are on the same machine. diff --git a/doc/screenshots/firefly-iii-di-start-screen.png b/doc/screenshots/firefly-iii-di-start-screen.png new file mode 100644 index 0000000..3c67683 Binary files /dev/null and b/doc/screenshots/firefly-iii-di-start-screen.png differ diff --git a/doc/screenshots/imac-complete.png b/doc/screenshots/imac-complete.png deleted file mode 100644 index b8e98ab..0000000 Binary files a/doc/screenshots/imac-complete.png and /dev/null differ