Skip to content

Commit 446bb91

Browse files
committed
Add professional README
1 parent 3fbbab3 commit 446bb91

File tree

1 file changed

+52
-41
lines changed

1 file changed

+52
-41
lines changed

README.md

Lines changed: 52 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,90 @@
1-
# Telegram Virus Scanner Bot
1+
# 🤖 Telegram Virus Scanner Bot
22

3-
🤖 بوت لفحص الروابط باستخدام [VirusTotal API](https://www.virustotal.com/).
3+
بوت لفحص الروابط باستخدام [VirusTotal API](https://www.virustotal.com/).
44

55
---
66

7-
## المتطلبات
7+
## 📝 المتطلبات
88

9-
- Python >= 3.11
10-
- مكتبات Python المطلوبة:
11-
- python-telegram-bot==20.5
12-
- requests==2.31.0
13-
- python-dotenv==1.0.0
9+
- **Python** >= 3.11
10+
- المكتبات المطلوبة:
11+
- `python-telegram-bot==20.5`
12+
- `requests==2.31.0`
13+
- `python-dotenv==1.0.0`
1414

1515
---
1616

17-
## تثبيت المشروع
17+
## تثبيت المشروع
1818

19-
1. استنساخ المستودع:
19+
1. **استنساخ المستودع:**
2020
```bash
2121
git clone https://github.com/username/telegram-bot.git
2222
cd telegram-bot
23+
```
2324

24-
2-إنشاء بيئة افتراضية وتفعيلها:
25+
2. **إنشاء بيئة افتراضية وتفعيلها:**
26+
```bash
2527
python -m venv venv
28+
2629
# على ويندوز
2730
venv\Scripts\activate
31+
2832
# على لينكس/ماك
2933
source venv/bin/activate
34+
```
3035

31-
3-تثبيت المكتبات:
36+
3. **تثبيت المكتبات المطلوبة:**
37+
```bash
3238
pip install -r requirements.txt
39+
```
3340

34-
4-إنشاء ملف .env وملئه بالمفاتيح:
41+
4. **إنشاء ملف `.env` وملئه بالمفاتيح:**
42+
```
3543
TELEGRAM_TOKEN=your_telegram_bot_token_here
3644
VIRUSTOTAL_API_KEY=your_virustotal_api_key_here
45+
```
3746

38-
تشغيل البوت
47+
5. **تشغيل البوت:**
48+
```bash
3949
python main.py
50+
```
4051

41-
-------------------------------------------------------------------
42-
43-
الأوامر المتاحة في البوت
44-
45-
/start - بداية التشغيل وشرح البوت
46-
47-
/help - المساعدة
48-
49-
/about - معلومات عن البوت
50-
51-
/scan <رابط> - فحص رابط محدد
52-
53-
/stats - عرض إحصائيات المستخدم
52+
---
5453

55-
/export - تصدير تقرير المستخدم
54+
## 🔹 الأوامر المتاحة في البوت
5655

57-
/clear - مسح التقرير
56+
| الأمر | الوصف |
57+
|----------------|------------------------------------------------|
58+
| `/start` | بداية التشغيل وشرح البوت |
59+
| `/help` | المساعدة |
60+
| `/about` | معلومات عن البوت |
61+
| `/scan <رابط>` | فحص رابط محدد |
62+
| `/stats` | عرض إحصائيات المستخدم |
63+
| `/export` | تصدير تقرير المستخدم |
64+
| `/clear` | مسح التقرير |
65+
| إرسال أي رابط مباشر | يتم فحصه تلقائيًا |
5866

59-
إرسال أي رابط مباشر لفحصه تلقائيًا
67+
---
6068

61-
------------------------------------------------------------------
62-
ملاحظات
69+
## 💡 ملاحظات مهمة
6370

64-
تأكد من عدم رفع ملف .env إلى GitHub.
71+
- **لا تقم برفع ملف `.env` إلى GitHub** لتجنب تسرب المفاتيح.
72+
- جميع السجلات يتم حفظها في ملفات `logs_<user_id>.txt`.
73+
- البوت يستخدم Telegram Bot API و VirusTotal API لفحص الروابط.
6574

66-
جميع السجلات يتم حفظها في ملفات logs_<user_id>.txt.
75+
---
6776

68-
هذا البوت يستخدم Telegram Bot API و VirusTotal API لفحص الروابط.
77+
## 🛠️ نصائح لاحتراف المشروع
6978

70-
--------------------------------------------------------------------
71-
نصائح إضافية لاحتراف المشروع
79+
1. استخدام مجلد `logs/` لحفظ السجلات بدل وضعها في مجلد الجذر.
80+
2. تحديث README دائمًا عند إضافة ميزات جديدة.
81+
3. عند تشغيل البوت على Render أو أي سيرفر، ضع `.env` مباشرة على السيرفر.
82+
4. إضافة ملف `LICENSE` (مثل MIT أو Apache) لتوضيح حقوق الاستخدام.
7283

73-
استخدام مجلد logs/ لحفظ الملفات بدل وضعها في مجلد الجذر.
84+
---
7485

75-
تحديث README دائمًا إذا أضفت ميزات جديدة.
86+
## 📌 روابط مفيدة
7687

77-
على Render أو أي سيرفر، ضع .env مباشرة على السيرفر بدل رفعه للمستودع.
88+
- [Telegram Bot API Documentation](https://core.telegram.org/bots/api)
89+
- [VirusTotal API Documentation](https://developers.virustotal.com/)
7890

79-
إضافة ملف LICENSE (MIT أو Apache) لتوضيح حقوق الاستخدام.

0 commit comments

Comments
 (0)