From 6c935bb7e3e73a9e34b8c22c04da68fb01c2fff4 Mon Sep 17 00:00:00 2001 From: Alessandro Autiero Date: Thu, 20 Apr 2023 19:52:22 +0200 Subject: [PATCH] Update README.md First draft of the new README: new discord short summary on what happened to the original library --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 49939e2..e64bfe3 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # Baileys - Typescript/Javascript WhatsApp Web API + +Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**. +Not running Selenium or Chromimum saves you like **half a gig** of ram :/ +Baileys supports interacting with the multi-device & web versions of WhatsApp. +Thank you to [@pokearaujo](https://github.com/pokearaujo/multidevice) for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to [@Sigalor](https://github.com/sigalor/whatsapp-web-reveng) for writing his observations on the workings of WhatsApp Web and thanks to [@Rhymen](https://github.com/Rhymen/go-whatsapp/) for the __go__ implementation. - Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**. Not running Selenium or Chromimum saves you like **half a gig** of ram :/ +## Please Read - Baileys supports interacting with the multi-device & web versions of WhatsApp. - - Thank you to [@pokearaujo](https://github.com/pokearaujo/multidevice) for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to [@Sigalor](https://github.com/sigalor/whatsapp-web-reveng) for writing his observations on the workings of WhatsApp Web and thanks to [@Rhymen](https://github.com/Rhymen/go-whatsapp/) for the __go__ implementation. - - Baileys is type-safe, extensible and simple to use. If you require more functionality than provided, it's super easy to write an extension. More on this [here](#WritingCustomFunctionality). +Baileys was recently taken down from Gitub as a result of a cease and desist from Whatsapp. +This request has no legal value(it's not the same thing as a DMCA strike), yet the project has been removed by its original author, Adhiraj Singh, and moved here. +This is the only official repository and is mantained by the community. + **Join the Discord [here](https://discord.gg/txhGQF7A7x)** - If you're interested in building a WhatsApp bot, you may wanna check out [WhatsAppInfoBot](https://github.com/adiwajshing/WhatsappInfoBot) and an actual bot built with it, [Messcat](https://github.com/ashokatechmin/Messcat). - - **Read the docs [here](https://adiwajshing.github.io/Baileys)** - **Join the Discord [here](https://discord.gg/WeJM5FP9GG)** - ## Example -Do check out & run [example.ts](https://github.com/adiwajshing/Baileys/blob/master/Example/example.ts) to see an example usage of the library. +Do check out & run [example.ts]( +/blob/master/Example/example.ts) to see an example usage of the library. The script covers most common use cases. To run the example script, download or clone the repo and then type the following in a terminal: 1. ``` cd path/to/Baileys ```