Skip to content

Commit b32f155

Browse files
committed
chore: readme
1 parent 94957ed commit b32f155

File tree

2 files changed

+9
-106
lines changed

2 files changed

+9
-106
lines changed

README.md

Lines changed: 9 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">Evolution Api</h1>
1+
<h1 align="center">Evolution API Lite</h1>
22

33
<div align="center">
44

@@ -7,131 +7,35 @@
77
[![Postman Collection](https://img.shields.io/badge/Postman-Collection-orange)](https://evolution-api.com/postman)
88
[![Documentation](https://img.shields.io/badge/Documentation-Official-green)](https://doc.evolution-api.com)
99
[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
10-
[![Support](https://img.shields.io/badge/Donation-picpay-green)](https://app.picpay.com/user/davidsongomes1998)
1110
[![Sponsors](https://img.shields.io/badge/Github-sponsor-orange)](https://github.com/sponsors/EvolutionAPI)
1211

1312
</div>
1413

1514
<div align="center"><img src="./public/images/cover.png"></div>
1615

17-
## Evolution API
16+
## Introduction
1817

19-
Evolution API began as a WhatsApp controller API based on [CodeChat](https://github.com/code-chat-br/whatsapp-api), which in turn implemented the [Baileys](https://github.com/WhiskeySockets/Baileys) library. While originally focused on WhatsApp, Evolution API has grown into a comprehensive platform supporting multiple messaging services and integrations. We continue to acknowledge CodeChat for laying the groundwork.
18+
**Evolution API Lite** is a lightweight version of the Evolution API, focusing solely on connectivity without the integrations and audio conversion features. It is designed to be more efficient and ideal for microservice environments where performance and simplicity are key.
2019

21-
Today, Evolution API is not limited to WhatsApp. It integrates with various platforms such as Typebot, Chatwoot, Dify, and OpenAI, offering a broad array of functionalities beyond messaging. Evolution API supports both the Baileys-based WhatsApp API and the official WhatsApp Business API, with upcoming support for Instagram and Messenger.
20+
## Core Features
2221

23-
## Types of Connections
22+
- **WhatsApp Connectivity**: Provides connectivity via WhatsApp Web using the [Baileys library](https://github.com/WhiskeySockets/Baileys).
23+
- **Official WhatsApp Cloud API**: Connects via Meta's official API for more reliable and scalable usage.
2424

25-
Evolution API supports multiple types of connections to WhatsApp, enabling flexible and powerful integration options:
26-
27-
- *WhatsApp API - Baileys*:
28-
- A free API based on WhatsApp Web, leveraging the [Baileys library](https://github.com/WhiskeySockets/Baileys).
29-
- This connection type allows control over WhatsApp Web functionalities through a RESTful API, suitable for multi-service chats, service bots, and other WhatsApp-integrated systems.
30-
- Note: This method relies on the web version of WhatsApp and may have limitations compared to official APIs.
31-
32-
- *WhatsApp Cloud API*:
33-
- The official API provided by Meta (formerly Facebook).
34-
- This connection type offers a robust and reliable solution designed for businesses needing higher volumes of messaging and better integration support.
35-
- The Cloud API supports features such as end-to-end encryption, advanced analytics, and more comprehensive customer service tools.
36-
- To use this API, you must comply with Meta's policies and potentially pay for usage based on message volume and other factors.
37-
38-
## Integrations
39-
40-
Evolution API supports various integrations to enhance its functionality. Below is a list of available integrations and their uses:
41-
42-
- [Typebot](https://typebot.io/):
43-
- Build conversational bots using Typebot, integrated directly into Evolution with trigger management.
44-
45-
- [Chatwoot](https://www.chatwoot.com/):
46-
- Direct integration with Chatwoot for handling customer service for your business.
47-
48-
- [RabbitMQ](https://www.rabbitmq.com/):
49-
- Receive events from the Evolution API via RabbitMQ.
50-
51-
- [Amazon SQS](https://aws.amazon.com/pt/sqs/):
52-
- Receive events from the Evolution API via Amazon SQS.
53-
54-
- [Socket.io](https://socket.io/):
55-
- Receive events from the Evolution API via WebSocket.
56-
57-
- [Dify](https://dify.ai/):
58-
- Integrate your Evolution API directly with Dify AI for seamless trigger management and multiple agents.
59-
60-
- [OpenAI](https://openai.com/):
61-
- Integrate your Evolution API with OpenAI for AI capabilities, including audio-to-text conversion, available across all Evolution integrations.
62-
63-
- Amazon S3 / Minio:
64-
- Store media files received in [Amazon S3](https://aws.amazon.com/pt/s3/) or [Minio](https://min.io/).
25+
This version does not include integrations with external platforms like Typebot, Chatwoot, OpenAI or S3/Minio, and there are no audio conversion features. It's optimized for those who need fast, simple connectivity solutions.
6526

6627
## Telemetry Notice
6728

6829
To continuously improve our services, we have implemented telemetry that collects data on the routes used, the most accessed routes, and the version of the API in use. We would like to assure you that no sensitive or personal data is collected during this process. The telemetry helps us identify improvements and provide a better experience for users.
6930

70-
## Evolution Support Premium
71-
72-
Join our Evolution Pro community for expert support and a weekly call to answer questions. Visit the link below to learn more and subscribe:
73-
74-
[Click here to learn more](https://evolution-api.com/suporte-pro)
75-
<br>
76-
<a href="https://evolution-api.com/suporte-pro">
77-
<img src="./public/images/evolution-pro.png" alt="Subscribe" width="600">
78-
</a>
79-
8031
# Donate to the project.
8132

8233
#### Github Sponsors
8334

8435
https://github.com/sponsors/EvolutionAPI
8536

86-
#### PicPay
87-
88-
<div align="center">
89-
<a href="https://app.picpay.com/user/davidsongomes1998" target="_blank" rel="noopener noreferrer">
90-
<img src="./public/images/picpay-qr.jpeg" style="width: 50% !important;">
91-
</a>
92-
</div>
93-
94-
#### Buy me coffe - PIX
95-
96-
<div align="center">
97-
<img src="./public/images/qrcode-pix.png" style="width: 50% !important;">
98-
<p><b>CHAVE PIX (Telefone):</b> (74)99987-9409</p>
99-
</div>
100-
101-
</br>
102-
103-
# Content Creator Partners
104-
105-
We are proud to collaborate with the following content creators who have contributed valuable insights and tutorials about Evolution API:
106-
107-
- [Promovaweb](https://www.youtube.com/@promovaweb)
108-
- [Comunidade ZDG](https://www.youtube.com/@ComunidadeZDG)
109-
- [Francis MNO](https://www.youtube.com/@FrancisMNO)
110-
- [Pablo Cabral](https://youtube.com/@pablocabral)
111-
- [XPop Digital](https://www.youtube.com/@xpopdigital)
112-
- [Costar Wagner Dev](https://www.youtube.com/@costarwagnerdev)
113-
- [Dante Testa](https://youtube.com/@dantetesta_)
114-
- [Rubén Salazar](https://youtube.com/channel/UCnYGZIE2riiLqaN9sI6riig)
115-
- [OrionDesign](youtube.com/OrionDesign_Oficial)
116-
- [IMPA 365](youtube.com/@impa365_ofc)
117-
- [Comunidade Hub Connect](https://youtube.com/@comunidadehubconnect)
118-
- [dSantana Automações](https://www.youtube.com/channel/UCG7DjUmAxtYyURlOGAIryNQ?view_as=subscriber)
119-
- [Edison Martins](https://www.youtube.com/@edisonmartinsmkt)
120-
- [Astra Online](https://www.youtube.com/@astraonlineweb)
121-
- [MKT Seven Automações](https://www.youtube.com/@sevenautomacoes)
122-
- [Vamos automatizar](https://www.youtube.com/vamosautomatizar)
123-
12437
## License
12538

126-
Evolution API is licensed under the Apache License 2.0, with the following additional conditions:
127-
128-
1. **Multi-tenant SaaS service**: Unless explicitly authorized in writing, you may not use the Evolution API source code to operate a multi-tenant environment.
129-
- Tenant Definition: Within the context of Evolution API, one tenant corresponds to one workspace. The workspace provides a separated area for each tenant's data and configurations.
130-
131-
2. **LOGO and copyright information**: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components.
132-
133-
Please contact [email protected] to inquire about licensing matters.
134-
135-
Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
39+
Evolution API Lite is licensed under the Apache License 2.0. See LICENSE for details.
13640

137-
© 2024 AtendAI
41+
© 2024 Evolution API

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@
7373
"mime": "^3.0.0",
7474
"node-cache": "^5.1.2",
7575
"pino": "^8.11.0",
76-
"prisma": "^5.15.0",
7776
"qrcode": "^1.5.1",
7877
"qrcode-terminal": "^0.12.0",
7978
"redis": "^4.6.5",

0 commit comments

Comments
 (0)