diff --git a/README.md b/README.md index c5c4bc37..c677f097 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Whatsapp Group](https://img.shields.io/badge/Group-WhatsApp-%2322BC18)](https://evolution-api.com/whatsapp) [![Discord Community](https://img.shields.io/badge/Discord-Community-blue)](https://evolution-api.com/discord) -[![Postman Collection](https://img.shields.io/badge/Postman-Collection-orange)](https://evolution-api.com/postman) +[![Postman Collection](https://img.shields.io/badge/Postman-Collection-orange)](https://evolution-api.com/postman) [![Documentation](https://img.shields.io/badge/Documentation-Official-green)](https://doc.evolution-api.com) [![License](https://img.shields.io/badge/license-GPL--3.0-orange)](./LICENSE) [![Support](https://img.shields.io/badge/Donation-picpay-green)](https://app.picpay.com/user/davidsongomes1998) @@ -16,20 +16,38 @@ ## WhatsApp-Api-NodeJs -This project is based on the [CodeChat](https://github.com/code-chat-br/whatsapp-api). The original project is an implementation of [Baileys](https://github.com/WhiskeySockets/Baileys), serving as a Restful API service that controls WhatsApp functions.
+This project is based on the [CodeChat](https://github.com/code-chat-br/whatsapp-api). The original project is an implementation of [Baileys](https://github.com/WhiskeySockets/Baileys), serving as a Restful API service that controls WhatsApp functions.
The code allows the creation of multiservice chats, service bots, or any other system that utilizes WhatsApp. The documentation provides instructions on how to set up and use the project, as well as additional information about its features and configuration options. ## SSL To install the SSL certificate, follow the **[instructions](https://certbot.eff.org/instructions?ws=other&os=ubuntufocal)** below. +## Installation + +### Self-hosted (VPS) + +For self-hosted installation, you will need a VPS with at least 2GB of RAM and 2vCPU. The installation process is simple, just follow the steps below. + + + +We recommend using the [Hetzner](https://hetzner.cloud/?ref=E1AsUeCv1soz) cloud service, which offers a 20 EUR credit for new accounts and helps the project with a small commission. + +### Heroku Button + +Automatically deploy to Heroku with the button below. You will need to create a free account on Heroku to use this feature. Average cost of hosting on Heroku is $7/month. + +For use heroku you need to use a MongoDB database, you can use [MongoDB Atlas](https://www.mongodb.com/atlas) for free. Before deploying to Heroku, create a database and copy the connection string to `DATABASE_CONNECTION_URI` environment variable. + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) + # Note This code is in no way affiliated with WhatsApp. Use at your own discretion. Don't spam this. This code was produced based on the baileys library and it is still under development. -# Donate to the project. +# Donate to the project #### PicPay @@ -47,4 +65,4 @@ This code was produced based on the baileys library and it is still under develo -
\ No newline at end of file +