Skip to content

Commit f22bbb8

Browse files
committed
README update
1 parent 56373dd commit f22bbb8

File tree

1 file changed

+18
-32
lines changed

1 file changed

+18
-32
lines changed

README.md

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,69 @@
11
<a href="https://t.me/AsPriceTrackerBot"> <img src="https://telegra.ph/file/081d452dd37708fb4777b.png" alt="Logo" style="border-radius:15px;"></a><br><br>
22

3-
# price-tracker [@AsTracker](https://t.me/AsPriceTrackerBot)
3+
# Price Tracker
44

5-
A Telegram bot that can track price of amazon & flipkart products (Soon more).
6-
If you like this project, please leave a 🌟.
5+
A Telegram bot that can track price of Amazon & flipkart products (more coming soon)
76

8-
---
7+
![Star](https://img.shields.io/github/stars/siddiquiaffan/price-tracker?label=Star&logo=Github)
8+
![GitHub Follow](https://img.shields.io/github/followers/siddiquiaffan?label=Follow&logo=GitHub)
9+
![State](https://img.shields.io/github/deployments/siddiquiaffan/price-tracker/github-pages?color=blue)
910

10-
- [Features](#features)
11-
- [Usage](#how-to-use)
12-
- [Deployment](#deploy)
13-
- [Contributing](#contributing)
14-
-
1511
---
1612

1713
## Features
1814

19-
```
2015
- Track Amazon Product.
2116
- Track Flipkart Product.
2217
- Notify on every price change.
2318
- Broadcast (Admin).
2419
- API support.
25-
```
2620

2721
---
2822

2923
## How to use
3024

31-
```
25+
> To use this bot in your Telegram, [click here](t.me/AsPriceTrackerBot)
26+
3227
/start - Start the bot
3328
/help - get this message.
3429
/track {Product Link} - Add product to tracking list.
3530
/stop {Tracking ID} - Stop tracking.
3631
/list - Get list of products that are being tracked.
37-
```
3832

3933
---
4034

4135
## Deploy
4236

4337
- [![Deploy with Heroku](https://www.herokucdn.com/deploy/button.svg "Deploy with Heroku")](https://heroku.com/deploy?template=https://github.com/siddiquiaffan/price-tracker "Deploy with Heroku")
4438

45-
- [![Deploy+on+Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https://github.com/siddiquiaffan/price-tracker&envs=ADMINS,BOT_TOKEN,DB_URL,WORKER_URL,API_KEY,LIMIT&ADMINSDesc=Telegarm+ids+of+admins+separated+by+space&BOT_TOKENDesc=Get+Your+Bot+Token+From+@BotFather.&DB_URLDesc=Create+A+Database+In+Mongodb+And+Get+URL.&WORKER_URLDesc=Paste+worker.js+code+in+Cloudfare+Worker+and+get+url.&API_KEYDesc=Any+secret+key+to+access+API&LIMITDesc=Limit+of+products+to+track+per+user.)
39+
- [![Deploy on Railway](https://railway.app/button.svg "Deploy on Railway")](https://railway.app/new/template?template=https://github.com/siddiquiaffan/price-tracker&envs=ADMINS,BOT_TOKEN,DB_URL,WORKER_URL,API_KEY,LIMIT&ADMINSDesc=Telegarm+ids+of+admins+separated+by+space&BOT_TOKENDesc=Get+Your+Bot+Token+From+@BotFather.&DB_URLDesc=Create+A+Database+In+Mongodb+And+Get+URL.&WORKER_URLDesc=Paste+worker.js+code+in+Cloudfare+Worker+and+get+url.&API_KEYDesc=Any+secret+key+to+access+API&LIMITDesc=Limit+of+products+to+track+per+user. "Deploy on Railway")
4640

47-
- ### Local -
41+
- ### Local
4842

49-
```
5043
- Clone Repository
5144
- Install Dependencies (npm install)
5245
- Create .env file and fill it with your details.
5346
- Start App (npm start)
54-
```
47+
5548
---
5649

5750
## Contributing
5851

59-
```
60-
- Fork this repo.
61-
- Make changes.
62-
- Create a pull request.
63-
```
52+
- Fork this repo ![fork](https://img.shields.io/github/forks/siddiquiaffan/price-tracker?label=fork&logo=Github)
53+
- Add your changes
54+
- Create a pull request
6455

6556
---
6657

6758
## NOTE
6859

69-
```
70-
- Do not clone this repo (You can fork it instead).
71-
- Use this bot at your own risk.
72-
- This bot can be a little bit slow cuz using cloudfare workers for scrapping product data (To avoid ip blocking from Amazon & Flipkart)
73-
```
60+
- Do not clone this repo (You can fork it instead)
61+
- Use this bot at your own risk
62+
- This bot can be a little bit slow because of using Cloudflare workers for scraping product data <br>
63+
(To avoid IP blocking from Amazon & Flipkart)
7464

7565
---
7666

7767
## License
7868

79-
[LICENSE](https://github.com/siddiquiaffan/price-tracker/blob/main/LICENSE)
80-
81-
---
82-
83-
### [Follow me on GitHub](https://github.com/siddiquiaffan)
69+
[LICENSE](https://github.com/siddiquiaffan/price-tracker/blob/main/LICENSE)

0 commit comments

Comments
 (0)