Skip to content

Commit da1c9b8

Browse files
author
asd
committed
Update README.md
1 parent f6ddc39 commit da1c9b8

File tree

5 files changed

+33
-16
lines changed

5 files changed

+33
-16
lines changed

README.md

+31-14
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,48 @@
22
[![License][license-shield]](LICENSE)
33
![Project Maintenance][maintenance-shield]
44

5-
# Instagram followers Integration for Home Assistant
5+
# Instagram followers counter Integration for Home Assistant
6+
This integration adds a sensor that retrieves the number of Instagram followers for a specified user.
67

8+
## 🛠️ Installation
79

8-
_Integration to integrate with [integration_blueprint][integration_blueprint]._
10+
1.Add this repository to your HACS with the following button:
911

10-
**This integration will set up the following platforms.**
12+
[![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=xamrex&repository=Hacs_Insta_follower&category=integration)
1113

12-
Platform | Description
13-
-- | --
14-
`sensor` | Show how many subscribers given instagram user has.
14+
2.Install this integration with the follwing button:
1515

16-
## Installation
16+
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=insta_follower)
1717

18-
1. Add this repository URL as a custom repository in HACS
19-
2. Restart Home Assistant
20-
3. In the HA UI go to "Settings" -> "Devices & services" click "+ ADD INTEGRATION" and search for "Insta Follower"*
18+
3.Enter Instagram Account name and Token and press Submit.
19+
![Configuration](https://raw.githubusercontent.com/xamrex/Hacs_Insta_follower/main/image/pic1.png)
2120

22-
## Configuration is done in the UI
21+
## ❓How to get token
22+
1. To get token you need to create an account on https://rapidapi.com/,
23+
2. Search for instagram scraper api https://rapidapi.com/social-api1-instagram/api/instagram-scraper-api2 and press Subscribe for Basic
24+
![Instagram API](https://raw.githubusercontent.com/xamrex/Hacs_Insta_follower/main/image/api1.png)
25+
3. **Token** is your **x-rapidapi-key**
26+
![Token](https://raw.githubusercontent.com/xamrex/Hacs_Insta_follower/main/image/api2.png)
2327

24-
<!---->
28+
## 🤷‍♂️ How it works?
29+
1. Every 6 hours there is an API call to get instagram followers counter.
30+
2. There is a **500** API Calls limit per month
2531

32+
## 🎯 Results
33+
![Result](https://raw.githubusercontent.com/xamrex/Hacs_Insta_follower/main/image/result.png)
2634

2735

28-
***
29-
3036
[integration_blueprint]: https://github.com/ludeeus/integration_blueprint
3137
[license-shield]: https://img.shields.io/github/license/ludeeus/integration_blueprint.svg?style=for-the-badge
3238
[maintenance-shield]: https://img.shields.io/badge/maintainer-xamrex-blue.svg?style=for-the-badge
39+
40+
41+
## 🤝 Contributing
42+
43+
You can contribute by creating a PR, but also by testing:
44+
45+
- Provide general feedback or report issues.
46+
47+
## 🛟 Need help?
48+
49+
If you have a feature request or encounter a problem, feel free to open an issue! Have a general question, need help setting up then go to the discussions.

custom_components/insta_follower/manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"domain": "insta_follower",
33
"name": "Insta Follower Counter",
44
"codeowners": [
5-
"@ludeeus"
5+
"@xamrex"
66
],
77
"config_flow": true,
88
"documentation": "https://github.com/xamrex/Hacs_Insta_follower",

custom_components/insta_follower/sensor.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ def native_value(self) -> int | None:
6464

6565
@property
6666
def unit_of_measurement(self) -> str | None:
67-
return "subs" # Set unit to 'subs'
67+
return "followers" # Set unit to 'subs'

image/pic1.PNG image/pic1.png

File renamed without changes.

image/result.png

15.2 KB
Loading

0 commit comments

Comments
 (0)