diff --git a/README.md b/README.md index d8eae12..931c5b3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Italo Image transfer tool for Indica Labs' HALO GUI with macOS ->[!IMPORTANT] +>[!TIP] >Italo requires access to HALO's GraphQL API server with a `scope=serviceuser|graphql` user account. For details on how to create the HALO service client, please see [Step 2](https://gitlab.com/indica_labs_public/example-code#step-2-create-halo-service-client) of Indica Labs' python example. ->[!TIP] +>[!WARNING] >Upon first start, press the `Search` button. Italo will then write a template configuration file named `secrets.json` to the current folder. Replace the values indicated by squared brackets `[ ]` with your custom configuration values: >```JSON >{ @@ -15,7 +15,7 @@ Image transfer tool for Indica Labs' HALO > "server_name": "[GraphQL server name]" >} >``` ->Please make sure to limit access to the `secrets.json` file to people you trust with modifying the HALO's SQL database. +>**Make sure to _limit access_ to the `secrets.json` file to people you trust with modifying HALO's SQL database.** >[!CAUTION] >Modifying entries in a database or copying files between storage systems bears the risk of unexpected behaviour and failures. HALO's SQL database reports errors upon failing transfer requests, and Italo only copies files without modification of the source or the target: However, you should favor stable network connections (ethernet > wifi) and avoid tunneling protocols (vpn) to improve your user experience.