Skip to content

Commit a66e322

Browse files
authored
Update README.md
1 parent 5359cd8 commit a66e322

1 file changed

Lines changed: 125 additions & 4 deletions

File tree

README.md

Lines changed: 125 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,127 @@
1-
# GetAnyMessage
2-
A Telegram Bot to receive messages from restricted chats!
1+
# 📨🔓 GetAnyMessage
2+
### get any message from any chat!
3+
**GetAnyMessage** is a powerful Telegram bot that lets you retrieve **restricted messages** (those that cannot be forwarded or copied) from any chat.
34

4-
_you can the bot here: [@GetAnyMessageRobot](https://t.me/GetAnyMessageRobot)_
5+
> 📨🔓 [@GetAnyMessageRobot](https://GetAnyMessageRobot.t.me)
56
6-
## The entire project will be available soon!
7+
[![AGPL License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](LICENSE)
8+
[![Made with ❤️ in Israel](https://img.shields.io/badge/Made%20with-%E2%9D%A4%EF%B8%8F%20in%20Israel-blue)](https://github.com/WizardLoop/GetAnyMessage)
9+
[![Docker Ready](https://img.shields.io/badge/docker-ready-blue.svg)](https://www.docker.com/)
10+
[![PHP 8.2+](https://img.shields.io/badge/PHP-8.2%2B-blue)](https://www.php.net/)
11+
12+
[![Telegram](https://img.shields.io/badge/Official%20Bot-000000?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/GetAnyMessageRobot)
13+
14+
---
15+
16+
## 📦 Features
17+
18+
- 🔓 Retrieve restricted messages from any chat
19+
- 📁 file support up to 4GB
20+
- 🧩 Supports groups, channels, private messages, bots
21+
- ⭐️ animated emoji's support
22+
- 💬 All types of messages
23+
- 🔁 Bypass Telegram forward/copy restrictions
24+
- ⚙️ Built with `MadelineProto` & PHP Coroutine Engine
25+
26+
---
27+
28+
### 🛠 Installation Setup
29+
30+
#### 1️⃣ Clone the repository
31+
32+
```bash
33+
git clone https://github.com/WizardLoop/GetAnyMessage.git
34+
cd GetAnyMessage
35+
```
36+
37+
#### 2️⃣ Install dependencies
38+
39+
Install PHP dependencies using Docker:
40+
```bash
41+
docker compose run --rm composer install
42+
```
43+
44+
#### 3️⃣ Launch the bot
45+
46+
```bash
47+
docker compose up --pull always -d
48+
```
49+
50+
The bot will start running in the background.
51+
52+
#### 🔍 View logs
53+
54+
```bash
55+
docker compose logs
56+
```
57+
Live log output of your bot.
58+
59+
---
60+
61+
## ⚙️ Common Commands
62+
63+
| Command | Description |
64+
|--------------------------------|--------------------------------------------------|
65+
| `docker compose build` | Build the Docker image |
66+
| `docker compose up --pull always -d` | Start the bot in the background |
67+
| `docker compose down` | Stop and remove the bot container |
68+
| `docker compose restart` | Restart the bot quickly |
69+
| `docker compose logs` | View real-time bot logs |
70+
| `docker compose exec bot composer dump-autoload` | Reload Composer autoload |
71+
| `docker-compose ps` | Show the status of Docker containers |
72+
73+
---
74+
75+
## 🔐 Environment Configuration
76+
77+
Copy `.env.example` to `.env` and fill in:
78+
79+
```bash
80+
cp .env.example .env
81+
```
82+
83+
- `API_ID`
84+
- `API_HASH`
85+
- `BOT_TOKEN`
86+
- `ADMIN_ID`
87+
88+
---
89+
90+
## 🧪 Testing & Code Quality
91+
92+
This project supports **PHPUnit**, **PHPCS**, and **PHP-CS-Fixer**.
93+
94+
### ✅ Run tests
95+
96+
```bash
97+
docker compose exec bot vendor/bin/phpunit
98+
```
99+
100+
### 🎨 Code style
101+
102+
```bash
103+
docker compose exec bot vendor/bin/phpcs
104+
docker compose exec bot vendor/bin/php-cs-fixer fix
105+
```
106+
107+
---
108+
109+
## 🤝 Contributing
110+
111+
Pull requests are welcome!
112+
113+
1. Fork the repo
114+
2. Create a branch: `git checkout -b fix/my-fix`
115+
3. Commit: `git commit -m 'Fix something'`
116+
4. Push: `git push origin fix/my-fix`
117+
5. Open a PR 🙌
118+
119+
---
120+
121+
## 📄 License
122+
123+
Licensed under the **GNU AGPL-3.0** — see [`LICENSE`](LICENSE).
124+
125+
---
126+
127+
Questions? Suggestions? Contact [@WizardLoop](https://t.me/WizardLoop).

0 commit comments

Comments
 (0)