Document migrating to this version of the add-on (#10)

* Add migration details

* Replace logo and icon

* Words

* Consistent add-on

* More words

DOCS.md

@@ -11,7 +11,7 @@ A self-hosted data logger for your Tesla 🚘
 - Visualization and data analysis with **Grafana**
 - Vehicle data is published to a local **MQTT** Broker
 
-This addon allows you to run [TeslaMate][teslamate] on your Home Assistant server based on the the official TeslaMate [docker image][docker].
+This add-on allows you to run [TeslaMate][teslamate] on your Home Assistant server based on the the official TeslaMate [docker image][docker].
 
 ## Configuration
 
@@ -64,7 +64,7 @@ See the [official docs][mosquitto-docs] on how to configure access control with
 
 #### Grafana Options
 
-I recommend you use the existing [Grafana addon][grafana-addon] from the community addons, if you do, please enable the following plugins in your yaml configurations, e.g.
+I recommend you use the existing [Grafana add-on][grafana-addon] from the community add-ons, if you do, please enable the following plugins in your yaml configurations, e.g.
 
 ```yaml
 plugins:
@@ -87,7 +87,7 @@ certfile: fullchain.pem    # optional if you are using TLS
 keyfile: privkey.pem       # optional if you are using TLS
 ```
 
-_Note_ that the security admin password and usernames can only be set on the first start of the Grafana addon, so if you already have it configured you'll need to use the same details or remove the add-on and re-add it.
+_Note_ that the security admin password and usernames can only be set on the first start of the Grafana add-on, so if you already have it configured you'll need to use the same details or remove the add-on and re-add it.
 
 - `grafana_import_dashboards`: (Optional, but recommended) Automatically import the grafana dashboards on startup?
 
@@ -122,11 +122,11 @@ It is now possible to import CSV data from TeslaFi, refer to the [official docs]
 Follow this process:
 
 1. Copy the CSV data to the `/share/teslamate` folder on your Home Assistant instance.
-   You can do this using the [Samba][samba-addon] or [SSH][ssh-addon] addons.
+   You can do this using the [Samba][samba-addon] or [SSH][ssh-addon] add-ons.
 
 2. Make sure the `import_path` configuration setting is set to `/share/teslamate`.
 
-3. Restart the TeslaMate addon and navigate to the web UI, you should be presented with the import screen.
+3. Restart the TeslaMate add-on and navigate to the web UI, you should be presented with the import screen.
 
 4. Import the data
 

README.md

@@ -11,9 +11,12 @@ A self-hosted data logger for your Tesla 🚘
 - Visualization and data analysis with **Grafana**
 - Vehicle data is published to a local **MQTT** Broker
 
-This addon allows you to run [TeslaMate][teslamate] on your Home Assistant server based on the the official TeslaMate [docker image][docker].
+This add-on allows you to run [TeslaMate][teslamate] on your Home Assistant server based on the the official TeslaMate [docker image][docker].
 
-[![Sponsor me to maintain this addon][sponsor-badge]](https://github.com/sponsors/lildude)
+This add-on is a fork of the unmaintained add-on at <https://github.com/matt-FFFFFF/hassio-addon-teslamate>.
+Thanks to @matt-FFFFFF for maintaining this add-on in the past.
+
+[![Sponsor me to maintain this add-on][sponsor-badge]](https://github.com/sponsors/lildude)
 
 ![TeslaMate Version][teslamate-version]
 ![Ingress][ingres-badge]
@@ -35,8 +38,8 @@ To get the full experience, it is recommended that you also install the communit
    [![Open add-on repo on your Home Assistant instance][repo-btn]][addon]
 
 1. Install this add-on.
-1. Install the PostgreSQL add-on and configure and start it, if you wish to use this add-on. The database name isn't important here as the TeslaMate addon will create the database you name in the settings if it doesn't exist.
-1. Configure Grafana as detailed in this addon's documentation.
+1. Install the PostgreSQL add-on and configure and start it, if you wish to use this add-on. The database name isn't important here as the TeslaMate add-on will create the database you name in the settings if it doesn't exist.
+1. Configure Grafana as detailed in this add-on's documentation.
 1. Enter your PostgreSQL configuration information.
 1. Enter your Grafana configuration information.
 1. Enter your MQTT configuration information.
@@ -45,6 +48,25 @@ To get the full experience, it is recommended that you also install the communit
 1. Check the logs of the add-on to see if everything went well.
 1. Click the `OPEN WEB UI` button to open TeslaMate.
 
+## Migrating to this version of the add-on
+
+Migrating to this version of the add-on should not result in any loss of data, but you can never be too careful, so I recommend you take a full backup of your Home Assistant instance and also a direct backup of the TeslaMate database as detailed in the [TeslaMate documentation][teslamate-backup] before proceeding.
+
+To migrate:
+
+1. Install this version of the TeslaMate add-on as per the details above. Keep your current version installed for now.
+1. Open the old add-on configuration options.
+1. Click the three dots at the top and select "Edit in YAML".
+1. Highlight and copy all the options.
+1. Open this add-on's configuration options.
+1. Click the three dots at the top and select "Edit in YAML".
+1. Replace all content with the configuration copied above.
+1. Stop the old add-on.
+1. Start the new add-on.
+1. Verify everything is working as before and uninstall the old add-on.
+
+Everything should pick up where it was before.
+
 [addon]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Flildude%2Fha-addons
 [addons-repo]: https://github.com/lildude/ha-addons
 [archs]: https://img.shields.io/badge/dynamic/json?color=green&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-teslamate%2Fmain%2Fconfig.json
@@ -56,5 +78,6 @@ To get the full experience, it is recommended that you also install the communit
 [postgres]: https://github.com/matt-FFFFFF/hassio-addon-postgres
 [repo-btn]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
 [sponsor-badge]: https://img.shields.io/badge/Sponsor_Me-%E2%9D%A4-ec6cb9?logo=GitHub
+[teslamate-backup]: https://docs.teslamate.org/docs/maintenance/backup_restore
 [teslamate-version]: https://img.shields.io/badge/dynamic/json?label=TeslaMate%20Version&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-teslamate%2Fmain%2Fbuild.json&query=%24.args.teslamate_version
 [teslamate]: https://github.com/teslamate-org/teslamate/