diff --git a/.github/README.md b/.github/README.md index e5516a1c..75fba0bf 100644 --- a/.github/README.md +++ b/.github/README.md @@ -8,19 +8,34 @@ Baileys is a WebSockets-based TypeScript library for interacting with the WhatsA Join the WhiskeySockets community via the link: https://whiskey.so/discord + +> [!IMPORTANT] +> I made a survey for users of the project to ask questions, and provide Baileys valuable insights regarding its users. I will be publishing the results of this form (after filtering) as well so we can study and understand where we need to work. +> +> The survey is anonymous and requires no personal info at all. You are required to sign-in with Google to keep responses to one person. You are able to edit your response after you submit. The deadline for this form is September 30, 2025. +> +> I encourage you to put the effort, all it takes is 5-10 minutes and you get to ask me any questions you have. - Rajeh (purpshell) +> +> Fill in the survey via the link: https://whiskey.so/survey + # Usage & Guide -A new guide has been posted at https://baileys.wiki (NOTE: This guide is still a work in progress). -The old guide can be accessed at the [README.md](https://github.com/WhiskeySockets/Baileys/tree/master/README.md) file or the [NPM homepage](https://npmjs.com/package/baileys). + +> [!IMPORTANT] +> The new guide is a work in progress. Expect missing pages, errors. You can still access the old guide here: [README.md](https://github.com/WhiskeySockets/Baileys/tree/master/README.md), or the [NPM homepage](https://npmjs.com/package/baileys). + +The new & full guide is posted at https://baileys.wiki . # Sponsor -If you'd like to financially support this project, you can do so by supporting the current maintainer [here](https://purpshell.dev/sponsor). +> [!TIP] +> If you'd like to financially support this project, you can do so by supporting the current maintainer [here](https://purpshell.dev/sponsor). # Disclaimer -This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. -The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners. - -The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used. -Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage. +> [!CAUTION] +> This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. +> The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners. +> +> The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used. +> Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage. # License Copyright (c) 2025 Rajeh Taher/WhiskeySockets