Skip to content

Commit b92c91e

Browse files
DavidsonGomesclaude
andcommitted
fix(docs): remove duplicate cover image from README
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 421980f commit b92c91e

1 file changed

Lines changed: 103 additions & 60 deletions

File tree

README.md

Lines changed: 103 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,58 @@
1+
<p align="center">
2+
<a href="https://evolutionfoundation.com.br">
3+
<img src="./public/hover-evolution.png" alt="Evolution Foundation" />
4+
</a>
5+
</p>
6+
17
<h1 align="center">Evolution Go</h1>
28

3-
<div align="center">
9+
<p align="center">
10+
High-performance WhatsApp API built in Go — part of the Evolution Foundation ecosystem.
11+
</p>
12+
13+
<p align="center">
14+
<a href="https://github.com/EvolutionAPI/evolution-go/releases/latest"><img src="https://img.shields.io/github/v/release/EvolutionAPI/evolution-go?include_prereleases&label=version&color=00ffa7" alt="Latest version" /></a>
15+
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0" /></a>
16+
<a href="https://docs.evolutionfoundation.com.br"><img src="https://img.shields.io/badge/Docs-evolutionfoundation.com.br-00ffa7" alt="Documentation" /></a>
17+
<a href="https://evolutionfoundation.com.br/community"><img src="https://img.shields.io/badge/Community-Join%20us-white" alt="Community" /></a>
18+
<a href="https://hub.docker.com/r/evoapicloud/evolution-go"><img src="https://img.shields.io/badge/Docker-evoapicloud-blue" alt="Docker image" /></a>
19+
</p>
20+
21+
<p align="center">
22+
<a href="https://evolutionfoundation.com.br">Website</a> &middot;
23+
<a href="https://docs.evolutionfoundation.com.br">Documentation</a> &middot;
24+
<a href="https://evolutionfoundation.com.br/community">Community</a> &middot;
25+
<a href="mailto:suporte@evofoundation.com.br">Support</a>
26+
</p>
427

5-
[![Docker Image](https://img.shields.io/badge/Docker-image-blue)](https://hub.docker.com/r/evoapicloud/evolution-go)
6-
[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
7-
[![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go)](https://golang.org/)
8-
[![GitHub Stars](https://img.shields.io/github/stars/EvolutionAPI/evolution-go)](https://github.com/EvolutionAPI/evolution-go/stargazers)
9-
[![Documentation](https://img.shields.io/badge/Documentation-Official-green)](https://docs.evolutionfoundation.com.br)
28+
---
1029

11-
</div>
30+
## About
1231

13-
<div align="center"><img src="./public/images/cover.png" width="400"></div>
32+
**Evolution Go** is a high-performance WhatsApp API built in Go. Part of the Evolution Foundation ecosystem, it provides a robust, lightweight solution for WhatsApp integration using the [whatsmeow](https://github.com/tulir/whatsmeow) library.
1433

15-
## About
34+
## Part of the Evolution Foundation ecosystem
35+
36+
Evolution Go is one of the messaging engines maintained by Evolution Foundation. It is used as a WhatsApp provider by the [Evo CRM Community](https://github.com/EvolutionAPI/evo-crm-community) and other projects in the ecosystem.
1637

17-
Evolution Go is a high-performance WhatsApp API built in Go, part of the [Evolution](https://evolutionfoundation.com.br/) ecosystem. It provides a robust, lightweight solution for WhatsApp integration using the [whatsmeow](https://github.com/tulir/whatsmeow) library.
38+
---
1839

1940
## Features
2041

21-
- **High Performance** — Built with Go for minimal resource usage
22-
- **RESTful API** — Clean, well-documented REST endpoints with Swagger
23-
- **Real-time Events** — WebSocket, Webhook, AMQP/RabbitMQ and NATS support
24-
- **Media Support** — Images, videos, audio, documents with MinIO/S3 storage
25-
- **Message Storage** — Optional PostgreSQL persistence
26-
- **QR Code Pairing** — Built-in QR code generation for device linking
27-
- **License Management** — Built-in licensing with registration, activation, and heartbeat
28-
- **Docker Ready** — Production-ready Docker configuration
42+
- **High performance** — built with Go for minimal resource usage
43+
- **RESTful API** — clean, well-documented REST endpoints with Swagger
44+
- **Real-time events** — WebSocket, Webhook, AMQP/RabbitMQ and NATS support
45+
- **Media support** — images, videos, audio, documents with MinIO/S3 storage
46+
- **Message storage** — optional PostgreSQL persistence
47+
- **QR code pairing** — built-in QR code generation for device linking
48+
- **License management** — built-in licensing with registration, activation, and heartbeat
49+
- **Docker ready** — production-ready Docker configuration
50+
51+
---
2952

3053
## Quick Start
3154

32-
### Docker (Recommended)
55+
### Docker (recommended)
3356

3457
```bash
3558
git clone https://github.com/EvolutionAPI/evolution-go.git
@@ -38,7 +61,7 @@ make docker-build
3861
make docker-run
3962
```
4063

41-
### Local Development
64+
### Local development
4265

4366
```bash
4467
git clone https://github.com/EvolutionAPI/evolution-go.git
@@ -55,6 +78,8 @@ make dev
5578

5679
> Run `make help` to see all available commands. See [COMMANDS.md](./COMMANDS.md) for detailed workflows.
5780
81+
---
82+
5883
## Configuration
5984

6085
Create a `.env` file:
@@ -87,13 +112,15 @@ LOGTYPE=console
87112
```
88113

89114
| Variable | Description | Default |
90-
|----------|-------------|---------|
115+
|---|---|---|
91116
| `SERVER_PORT` | Server port | `8080` |
92117
| `CLIENT_NAME` | Client identifier | `evolution` |
93118
| `GLOBAL_API_KEY` | API authentication key | **Required** |
94119
| `DATABASE_SAVE_MESSAGES` | Enable message storage | `false` |
95120
| `WADEBUG` | WhatsApp debug level | `INFO` |
96121

122+
---
123+
97124
## License Activation
98125

99126
Evolution Go requires a license to operate. On first run:
@@ -106,6 +133,8 @@ Evolution Go requires a license to operate. On first run:
106133

107134
The license status persists in the database (`runtime_configs` table). Heartbeats are sent periodically to maintain activation.
108135

136+
---
137+
109138
## API Documentation
110139

111140
Swagger UI available at:
@@ -117,14 +146,16 @@ http://localhost:8080/swagger/index.html
117146
### Key Endpoints
118147

119148
| Method | Endpoint | Description |
120-
|--------|----------|-------------|
149+
|---|---|---|
121150
| `POST` | `/instance/create` | Create WhatsApp instance |
122151
| `GET` | `/instance/{name}/qrcode` | Get QR code for pairing |
123152
| `POST` | `/message/sendText` | Send text message |
124153
| `POST` | `/message/sendMedia` | Send media message |
125154
| `GET` | `/instance/{name}/status` | Get instance status |
126155
| `DELETE` | `/instance/{name}` | Delete instance |
127156

157+
---
158+
128159
## Project Structure
129160

130161
```
@@ -136,7 +167,7 @@ evolution-go/
136167
│ ├── message/ # Message handling
137168
│ ├── sendMessage/ # Message sending
138169
│ ├── routes/ # HTTP routes
139-
│ ├── middleware/ # Auth & validation middleware
170+
│ ├── middleware/ # Auth & validation middleware
140171
│ ├── config/ # Configuration
141172
│ ├── events/ # Event producers (AMQP, NATS, Webhook, WS)
142173
│ └── storage/ # Media storage (MinIO)
@@ -147,78 +178,90 @@ evolution-go/
147178
└── VERSION
148179
```
149180

150-
## Technology Stack
181+
---
182+
183+
## Tech Stack
151184

152185
| Component | Technology |
153-
|-----------|-----------|
186+
|---|---|
154187
| Language | Go 1.24+ |
155-
| HTTP Framework | Gin |
188+
| HTTP framework | Gin |
156189
| WhatsApp | [whatsmeow](https://github.com/tulir/whatsmeow) |
157190
| Database | PostgreSQL |
158191
| ORM | GORM |
159-
| Message Queue | RabbitMQ, NATS |
160-
| Object Storage | MinIO/S3 |
192+
| Message queue | RabbitMQ, NATS |
193+
| Object storage | MinIO/S3 |
161194
| Documentation | Swagger/OpenAPI |
162195
| Container | Docker |
163196

164-
## Documentation & Support
197+
---
198+
199+
## Documentation
165200

166201
| Resource | Link |
167-
|----------|------|
168-
| Website | [evolutionfoundation.com.br](https://evolutionfoundation.com.br/) |
169-
| Documentation | [docs.evolutionfoundation.com.br](https://docs.evolutionfoundation.com.br/) |
202+
|---|---|
203+
| Website | [evolutionfoundation.com.br](https://evolutionfoundation.com.br) |
204+
| Documentation | [docs.evolutionfoundation.com.br](https://docs.evolutionfoundation.com.br) |
170205
| Community | [evolutionfoundation.com.br/community](https://evolutionfoundation.com.br/community) |
171-
| WhatsApp Support | [+55 31 9621-9989](https://wa.me/553196219989) |
172-
| GitHub Issues | [evolution-go/issues](https://github.com/EvolutionAPI/evolution-go/issues) |
206+
| Docker Hub | [evoapicloud/evolution-go](https://hub.docker.com/r/evoapicloud/evolution-go) |
207+
| Changelog | [CHANGELOG.md](./CHANGELOG.md) |
208+
| Contributing | [CONTRIBUTING.md](./CONTRIBUTING.md) |
209+
| Security | [SECURITY.md](./SECURITY.md) |
210+
211+
---
173212

174213
## Hosting
175214

176215
Deploy Evolution Go with optimized infrastructure:
177216

178217
| Product | Link |
179-
|---------|------|
180-
| Evolution Go VPS | [Hostgator - Evo Go](https://www.hostgator.com.br/52579-144-3-55.html) |
181-
| Evolution API VPS | [Hostgator - Evo API](https://www.hostgator.com.br/servidor-vps/hospedagem-evo-api/lp-afiliado) |
218+
|---|---|
219+
| Evolution Go VPS | [HostGator — Evo Go](https://www.hostgator.com.br/52579-144-3-55.html) |
220+
| Evolution API VPS | [HostGator — Evo API](https://www.hostgator.com.br/servidor-vps/hospedagem-evo-api/lp-afiliado) |
182221

183-
## Contributing
222+
---
223+
224+
## Telemetry
184225

185-
1. Fork the repository
186-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
187-
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
188-
4. Push to the branch (`git push origin feature/amazing-feature`)
189-
5. Open a Pull Request
226+
Evolution Go collects anonymous telemetry data (routes used, API version) to help improve the service. **No sensitive or personal data is collected.**
190227

191-
## Security
228+
---
192229

193-
For security concerns, please email: contato@evolution-api.com
230+
## Contributing
194231

195-
## License
232+
Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to submit issues, propose features, and open pull requests.
196233

197-
Evolution Go is licensed under the Apache License 2.0, with the following additional conditions:
234+
Join our [community](https://evolutionfoundation.com.br/community) to discuss ideas and collaborate.
198235

199-
1. **Logo and copyright**: You may not remove or modify the logo or copyright information in the Evolution console or applications when using frontend components.
236+
---
200237

201-
2. **Usage notification**: If Evolution Go is used as part of any project (including closed-source), a clear notification that Evolution Go is being utilized must be visible to system administrators.
238+
## Security
202239

203-
Please contact contato@evolution-api.com for licensing inquiries. Full license details at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
240+
For security issues, **do not open a public issue**. Email **suporte@evofoundation.com.br** or use GitHub's private vulnerability reporting. See [SECURITY.md](./SECURITY.md) for details.
241+
242+
---
204243

205244
## Acknowledgments
206245

207-
- [whatsmeow](https://github.com/tulir/whatsmeow) by [tulir](https://github.com/tulir)
208-
- [Evolution API](https://github.com/EvolutionAPI/evolution-api)
246+
- [whatsmeow](https://github.com/tulir/whatsmeow) by [Tulir Asokan](https://github.com/tulir) — WhatsApp protocol library
247+
- [Evolution API](https://github.com/EvolutionAPI/evolution-api) — Node.js sister project
209248

210-
## Telemetry
249+
---
211250

212-
Evolution Go collects anonymous telemetry data (routes used, API version) to improve the service. No sensitive or personal data is collected.
251+
## License
213252

214-
---
253+
Evolution Go is licensed under the Apache License 2.0, with additional brand-protection conditions (LOGO/copyright preservation and Usage Notification requirement). See [LICENSE](./LICENSE) for full details.
215254

216-
<div align="center">
255+
For licensing inquiries, contact **suporte@evofoundation.com.br**.
217256

218-
**Evolution Go** — High-Performance WhatsApp API
257+
## Trademarks
219258

220-
Made with ❤️ by the [Evolution Team](https://evolutionfoundation.com.br/)
259+
"Evolution Foundation", "Evolution" and "Evolution Go" are trademarks of Evolution Foundation. See [TRADEMARKS.md](./TRADEMARKS.md) for the brand assets policy.
221260

222-
© 2025 Evolution Foundation
261+
Third-party attributions are documented in [NOTICE](./NOTICE).
262+
263+
---
223264

224-
</div>
265+
<p align="center">
266+
Made by <a href="https://evolutionfoundation.com.br">Evolution Foundation</a> · © 2026
267+
</p>

0 commit comments

Comments
 (0)