Merge pull request #82 from andrew-codechimp/retire

Retire

README.md

@@ -1,84 +1,15 @@
 # Home Assistant Mastodon Profile Stats Integration
 
-[![GitHub Release][releases-shield]][releases]
-[![GitHub Activity][commits-shield]][commits]
-[![Downloads][download-latest-shield]](Downloads)
-[![License][license-shield]](LICENSE)
-[![hacs][hacsbadge]][hacs]
-[![Community Forum][forum-shield]][forum]
+**This integration has now been retired.**
 
+With the 2024.9 release of Home Assistant the official Mastodon integration has been enhanced to include statistics, meeting feature parity with this custom integration. Therefore I will be retiring this integration and am now a code owner for the official one and will continue improving/maintaining things there.
 
-Integration to get profile stats from Mastodon instances (multiple supported).
+How do you remove the custom integration and move to core?
+* Within Settings, Devices & Services, Integrations, open Mastodon Profile Stats.
+* Use the 3 dots to choose Delete
+* Then within HACS find Mastodon Profile Stats, and choose Delete to remove the custom integration.
+* Restart HA
+* Go to Settings, Devices & Services, Integrations and click Add Integration
+* Search for Mastodon and follow the integration steps.
 
-*Please :star: this repo if you find it useful*  
-*If you want to show your support please*
-
-[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)
-
-![Mastodon Profile Stats](https://github.com/andrew-codechimp/HA-Mastodon-Profile-Stats/blob/main/images/screenshot-device.png "Mastodon Profile Stats")
-
-
-**This integration will set up the following platforms.**
-
-Platform | Description
--- | --
-`sensor` | Show info from Mastodon profile API, polled every 60 minutes
-
-## Sensors
-
-| Sensor      | Description                                                                                                                                                                                                               |
-| :------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `[PROFILE NAME]_[MASTODON INSTANCE]_followers`    | Number of followers                                                                                                                                                                                              |
-| `[PROFILE NAME]_[MASTODON INSTANCE]_following` | Number of following                                                                                                      |
-| `[PROFILE NAME]_[MASTODON INSTANCE]_statuses`     | Number of posts |
-
-## Installation
-
-### HACS
-
-[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=andrew-codechimp&repository=HA-Mastodon-Profile-Stats&category=Integration)
-
-Or  
-Search for `Mastodon Profile Stats` in HACS and install it under the "Integrations" category.  
-Restart Home Assistant  
-In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Mastodon Profile Stats"  
-
-### Manual Installation
-
-<details>
-<summary>Show detailed instructions</summary>
-
-Installation via HACS is recommended, but a manual setup is supported.
-
-1. Manually copy custom_components/mastodon_profile_stats folder from latest release to custom_components folder in your config folder.
-1. Restart Home Assistant.
-1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Mastodon Profile Stats"
-
-</details>
-
-## Configuration is done in the UI
-
-Add a profile via either @profilename@mastodoninstance or the url
-
-Multiple profiles are supported and the stats are updated every 60 minutes
-<!---->
-
-If you find this useful and want to show your support  
-
-[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)
-
-
-***
-
-[mastodon_profile_stats]: https://github.com/andrew-codechimp/HA-Mastodon-Profile-Stats
-[commits-shield]: https://img.shields.io/github/commit-activity/y/andrew-codechimp/HA-Mastodon-Profile-Stats.svg?style=for-the-badge
-[commits]: https://github.com/andrew-codechimp/HA-Mastodon-Profile-Stats/commits/main
-[hacs]: https://github.com/hacs/integration
-[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge
-[exampleimg]: example.png
-[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
-[forum]: https://community.home-assistant.io/t/custom-component-mastodon-profile-stats/601024
-[license-shield]: https://img.shields.io/github/license/andrew-codechimp/HA-Mastodon-Profile-Stats.svg?style=for-the-badge
-[releases-shield]: https://img.shields.io/github/release/andrew-codechimp/HA-Mastodon-Profile-Stats.svg?style=for-the-badge
-[releases]: https://github.com/andrew-codechimp/HA-Mastodon-Profile-Stats/releases
-[download-latest-shield]: https://img.shields.io/github/downloads/andrew-codechimp/ha-mastodon-profile-stats/latest/total?style=for-the-badge
+Thanks to everyone who supported this integration.

custom_components/mastodon_profile_stats/__init__.py

@@ -39,6 +39,12 @@ async def async_setup(
         LOGGER.critical(msg)
         return False
 
+    LOGGER.warning(
+        "This integration has been discontinued, "
+        "please remove the integration, delete within HACS and use the official "
+        "integration https://www.home-assistant.io/integrations/mastodon"
+    )
+
     return True