-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from neeru24/patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
104 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,122 @@ | ||
# Crypto Bot - Telegram Bot for Cryptocurrency Prices | ||
# 🚀 **Crypto Bot** - Telegram Bot for Real-Time Cryptocurrency Prices 💰 | ||
|
||
Crypto Bot is a simple yet powerful Telegram bot that allows users to get real-time cryptocurrency prices with the ease of clicking a button. Whether you're a trader or a crypto enthusiast, this bot provides you with up-to-date information about any cryptocurrency you're interested in. | ||
Crypto Bot is a **simple yet powerful** Telegram bot that provides real-time cryptocurrency prices 📈 with just a click of a button! Whether you're a seasoned trader or a crypto enthusiast, this bot keeps you updated with the **latest market trends** in the crypto world 🌍. | ||
|
||
## Features | ||
--- | ||
|
||
- **Instant Prices**: Get real-time prices for various cryptocurrencies. | ||
- **User-Friendly**: Simply click a button to fetch the price of your desired crypto product. | ||
- **Multi-Currency Support**: Supports a wide range of cryptocurrencies including Bitcoin, Ethereum, Litecoin, and more. | ||
### ✨ **Features** ✨ | ||
|
||
## How to Use | ||
💡 **Instant Prices**: Get real-time prices for your favorite cryptocurrencies instantly! | ||
🕹️ **User-Friendly**: Just tap a button, and the bot will fetch the price for you. | ||
🌍 **Multi-Currency Support**: Track prices for **Bitcoin, Ethereum, Litecoin,** and more! | ||
|
||
1. Start the bot on Telegram. | ||
2. Choose the cryptocurrency you want to check. | ||
3. Click the button to get the latest price for the selected currency. | ||
--- | ||
|
||
## Here's The link For Telegram Bot | ||
### 🎯 **How to Use** 🎯 | ||
|
||
Click Here : https://t.me/trackingcryptopricerbot | ||
1. **Start the Bot** on Telegram 📨 | ||
2. **Choose the Cryptocurrency** you want to check 💱 | ||
3. **Click the Button** to get the latest price for that currency 💸 | ||
|
||
## Installation | ||
🚀 **Get Started Here:** [Click to Launch the Bot](https://t.me/trackingcryptopricerbot) 🚀 | ||
|
||
To run this bot locally, follow the steps below: | ||
--- | ||
|
||
1. ## Clone the repository: | ||
### 🛠️ **Installation** 🛠️ | ||
|
||
If you want to run this bot locally, follow these steps: | ||
|
||
1. **Clone the Repository** 📂 | ||
```bash | ||
git clone https://github.com/yourusername/crypto-bot.git | ||
cd crypto-bot | ||
``` | ||
2. ## Install Dependencies | ||
|
||
Install the required Python libraries: | ||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
Required Libraries: | ||
|
||
python-telegram-bot | ||
requests | ||
2. **Install Dependencies** 🛠️ | ||
Install the necessary Python libraries: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
|
||
3. ## Set Up Your Bot on Telegram | ||
Open Telegram and search for "BotFather". | ||
Type /newbot and follow the instructions to create a new bot. | ||
Copy the TOKEN provided by BotFather. | ||
4. ## Set Environment Variables | ||
Store your bot token as an environment variable for secure access: | ||
3. **Required Libraries** | ||
|
||
- `python-telegram-bot` | ||
- `requests` | ||
|
||
On Windows: | ||
--- | ||
|
||
Search for "Environment Variables" and add a new user variable called BOT_TOKEN with your bot token as the value. | ||
On Linux/Mac: | ||
### ⚙️ **Set Up Your Bot on Telegram** ⚙️ | ||
|
||
In the terminal, run: | ||
```bash | ||
export BOT_TOKEN="your_bot_token_here" | ||
``` | ||
Alternatively, replace os.getenv("BOT_TOKEN") in the code with your token directly (not recommended for production). | ||
5. ## Running the Bot | ||
Once you’ve set your bot token, you can start the bot by running the Python script: | ||
|
||
``` | ||
python bot.py | ||
``` | ||
You should see Polling....., meaning your bot is now running and ready to respond to commands. | ||
|
||
## Usage | ||
Here are the available commands: | ||
``` | ||
/start: Initiate the bot. | ||
/help: Get help about how to use the bot. | ||
/price: Fetch real-time cryptocurrency prices (Bitcoin, Ethereum, Litecoin). | ||
``` | ||
1. **Create a New Bot**: | ||
Search for **BotFather** on Telegram. Type `/newbot` and follow the instructions to create your bot. | ||
|
||
2. **Get Your Token**: | ||
Copy the TOKEN provided by BotFather. | ||
|
||
--- | ||
|
||
### 🔐 **Set Environment Variables** 🔐 | ||
|
||
Store your bot token securely as an environment variable. | ||
|
||
**On Windows**: | ||
|
||
- Open "Environment Variables" and add a user variable called `BOT_TOKEN` with your bot token as the value. | ||
|
||
**On Linux/Mac**: | ||
|
||
- In the terminal, run: | ||
|
||
```bash | ||
export BOT_TOKEN="your_bot_token_here" | ||
``` | ||
|
||
💡 Alternatively, replace `os.getenv("BOT_TOKEN")` in the code with your token (not recommended for production). | ||
|
||
--- | ||
|
||
### ▶️ **Running the Bot** ▶️ | ||
|
||
To start the bot, run the following command: | ||
|
||
```bash | ||
python bot.py | ||
``` | ||
|
||
You should see **"Polling..."**, which means your bot is now running and ready to fetch real-time cryptocurrency prices! 🚀💸 | ||
|
||
--- | ||
|
||
### 🧑💻 **Bot Commands** 🧑💻 | ||
|
||
Here’s what you can do with the bot: | ||
|
||
* **/start**: Initiate the bot 🤖 | ||
* **/help**: Get help on how to use the bot 💡 | ||
* **/price**: Fetch real-time prices for **Bitcoin, Ethereum, Litecoin** and more! 💰 | ||
|
||
--- | ||
|
||
### 🤝 **Contributions Welcome!** 🤝 | ||
|
||
We would love your contributions to make **Crypto Bot** even better! Whether it's adding new features, improving performance, or fixing bugs, your help is appreciated. | ||
Feel free to: | ||
* Fork the repository 🍴 | ||
* Make your changes 🛠️ | ||
* Submit a pull request 🔄 | ||
Together, let's build an even more amazing bot! 🌟 | ||
|
||
--- | ||
|
||
### 📲 **Enjoy Tracking Crypto with Ease!** 📲 | ||
|
||
Now, you're all set to track cryptocurrency prices effortlessly and stay on top of the market! | ||
🔗 **Telegram Bot Link:** [Click to Use](https://t.me/trackingcryptopricerbot) | ||
#### 🌟 **If you like this project, don't forget to star the repo! And be sure to follow [OpenTekHub](https://github.com/OpenTekHub) for more updates!** | ||
|
||
🎉 Happy Tracking! 💰📈 |