From 07c80838fa7b839746e237d5d82e964a086d945a Mon Sep 17 00:00:00 2001 From: qzdark Date: Thu, 18 Apr 2024 22:10:26 +0200 Subject: [PATCH 1/5] style: guide link fix and detailed description Due to updates in the guide, the link broke. I also added a banner to make it look similar to the guide's readme. Additionally, changed link inclusion and revised text for better clarity, aligning it with the descriptive style used in the guide's descriptions. --- README.md | 110 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 72 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 24eba1af5..e719da57e 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,46 @@ -[![npm](https://img.shields.io/npm/v/whatsapp-web.js.svg)](https://www.npmjs.com/package/whatsapp-web.js) [![Depfu](https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg)](https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765) ![WhatsApp_Web 2.2346.52](https://img.shields.io/badge/WhatsApp_Web-2.2346.52-brightgreen.svg) [![Discord Chat](https://img.shields.io/discord/698610475432411196.svg?logo=discord)](https://discord.gg/H7DqQs4) - -# whatsapp-web.js -A WhatsApp API client that connects through the WhatsApp Web browser app - -It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked. - -**NOTE:** I can't guarantee you will not be blocked by using this method, although it has worked for me. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe. - -## Quick Links - -* [Guide / Getting Started](https://wwebjs.dev/guide) _(work in progress)_ -* [Reference documentation](https://docs.wwebjs.dev/) -* [GitHub](https://github.com/pedroslopez/whatsapp-web.js) -* [npm](https://npmjs.org/package/whatsapp-web.js) +
+
+

+ wwebjs.dev Guide +

+
+
+

+ npm + Depfu + WhatsApp_Web 2.2333.11 + Discord server +

+
+ +## About +**A WhatsApp API client that connects through the WhatsApp Web browser app** + +The library works by launching the WhatsApp Web browser application and managing it using Puppeteer to create an instance of WhatsApp Web, thereby mitigating the risk of being blocked. The WhatsApp API client connects through the WhatsApp Web browser app, accessing its internal functions. This grants you access to nearly all the features available on WhatsApp Web, enabling dynamic handling similar to any other Node.js application. + +**NOTE:** It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe. + +## Links + +* [Website][website] +* [Guide][guide] ([source][guide-source]) _(work in progress)_ +* [Documentation][documentation] ([source][documentation-source]) +* [WWebJS Discord][discord] +* [GitHub][gitHub] +* [npm][npm] ## Installation The module is now available on npm! `npm i whatsapp-web.js` -Please note that Node v18+ is required. +Please note that Node ``v18+`` is required. ## QUICK STEPS TO UPGRADE NODE ### Windows #### Manual -Just get the latest LTS from https://nodejs.org +Just get the latest LTS from the [official node website][nodejs]. #### npm ```powershell @@ -74,9 +89,8 @@ client.on('message', msg => { client.initialize(); ``` -Take a look at [example.js](https://github.com/pedroslopez/whatsapp-web.js/blob/master/example.js) for another example with more use cases. - -For more information on saving and restoring sessions, check out the available [Authentication Strategies](https://wwebjs.dev/guide/authentication.html). +Take a look at [example.js][examples] for another examples with additional use cases. +For further details on saving and restoring sessions, explore the provided [Authentication Strategies][auth-strategies]. ## Supported features @@ -87,13 +101,13 @@ For more information on saving and restoring sessions, check out the available [ | Send messages | ✅ | | Receive messages | ✅ | | Send media (images/audio/documents) | ✅ | -| Send media (video) | ✅ [(requires google chrome)](https://wwebjs.dev/guide/handling-attachments.html#caveat-for-sending-videos-and-gifs) | +| Send media (video) | ✅ [(requires google chrome)][google-chrome] | | Send stickers | ✅ | | Receive media (images/audio/video/documents) | ✅ | | Send contact cards | ✅ | | Send location | ✅ | | Send buttons | ❌ | -| Send lists | ❌ [(DEPRECATED)](https://www.youtube.com/watch?v=hv1R1rLeVVE) | +| Send lists | ❌ [(DEPRECATED)][deprecated-video] | | Receive location | ✅ | | Message replies | ✅ | | Join groups by invite | ✅ | @@ -117,30 +131,50 @@ Something missing? Make an issue and let us know! ## Contributing -Pull requests are welcome! If you see something you'd like to add, please do. For drastic changes, please open an issue first. +Feel free to open pull requests; we welcome contributions! However, for significant changes, it's best to open an issue beforehand. Make sure to review our [contribution guidelines][contributing] before creating a pull request. Before creating your own issue or pull request, always check to see if one already exists! ## Supporting the project You can support the maintainer of this project through the links below -- [Support via GitHub Sponsors](https://github.com/sponsors/pedroslopez) -- [Support via PayPal](https://www.paypal.me/psla/) -- [Sign up for DigitalOcean](https://m.do.co/c/73f906a36ed4) and get $200 in credit when you sign up (Referral) +- [Support via GitHub Sponsors][gitHub-sponsors] +- [Support via PayPal][support-payPal] +- [Sign up for DigitalOcean][digitalocean] and get $200 in credit when you sign up (Referral) ## 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 https://whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners. +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]. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners. Also it is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe. ## License -Copyright 2019 Pedro S Lopez - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this project except in compliance with the License. -You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +Copyright 2019 Pedro S Lopez + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this project except in compliance with the License. +You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + +[website]: https://wwebjs.dev +[guide]: https://guide.wwebjs.dev/guide +[guide-source]: https://github.com/wwebjs/wwebjs.dev/tree/main +[documentation]: https://docs.wwebjs.dev/ +[documentation-source]: https://github.com/pedroslopez/whatsapp-web.js/tree/main/docs +[discord]: https://discord.gg/H7DqQs4 +[gitHub]: https://github.com/pedroslopez/whatsapp-web.js +[npm]: https://npmjs.org/package/whatsapp-web.js +[nodejs]: https://nodejs.org/en/download/ +[examples]: https://github.com/pedroslopez/whatsapp-web.js/blob/master/example.js +[auth-strategies]: https://wwebjs.dev/guide/creating-your-bot/authentication.html +[google-chrome]: https://wwebjs.dev/guide/handling-attachments.html#caveat-for-sending-videos-and-gifs +[deprecated-video]: https://www.youtube.com/watch?v=hv1R1rLeVVE +[gitHub-sponsors]: https://github.com/sponsors/pedroslopez +[support-payPal]: https://www.paypal.me/psla/ +[digitalocean]: https://m.do.co/c/73f906a36ed4 +[contributing]: https://github.com/pedroslopez/whatsapp-web.js/blob/main/CODE_OF_CONDUCT.md +[whatsapp]: https://whatsapp.com \ No newline at end of file From 919a40ad5c3c31456b249a0a81efab217a390749 Mon Sep 17 00:00:00 2001 From: alechkos <93551621+alechkos@users.noreply.github.com> Date: Fri, 19 Apr 2024 02:20:33 +0300 Subject: [PATCH 2/5] fix: change to current wweb version in the lib --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e719da57e..fe7d47f34 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

npm Depfu - WhatsApp_Web 2.2333.11 + WhatsApp_Web 2.2346.52 Discord server

From 7f29cc358eb23a033f3a02c8c4db024bf9732496 Mon Sep 17 00:00:00 2001 From: alechkos <93551621+alechkos@users.noreply.github.com> Date: Fri, 19 Apr 2024 02:37:23 +0300 Subject: [PATCH 3/5] style: bring minor changes --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fe7d47f34..907768b07 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ The library works by launching the WhatsApp Web browser application and managing it using Puppeteer to create an instance of WhatsApp Web, thereby mitigating the risk of being blocked. The WhatsApp API client connects through the WhatsApp Web browser app, accessing its internal functions. This grants you access to nearly all the features available on WhatsApp Web, enabling dynamic handling similar to any other Node.js application. -**NOTE:** It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe. +> [!IMPORTANT] +> **It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.** ## Links @@ -33,7 +34,8 @@ The library works by launching the WhatsApp Web browser application and managing The module is now available on npm! `npm i whatsapp-web.js` -Please note that Node ``v18+`` is required. +> [!NOTE] +> **Node ``v18+`` is required.** ## QUICK STEPS TO UPGRADE NODE @@ -101,12 +103,12 @@ For further details on saving and restoring sessions, explore the provided [Auth | Send messages | ✅ | | Receive messages | ✅ | | Send media (images/audio/documents) | ✅ | -| Send media (video) | ✅ [(requires google chrome)][google-chrome] | +| Send media (video) | ✅ [(requires Google Chrome)][google-chrome] | | Send stickers | ✅ | | Receive media (images/audio/video/documents) | ✅ | | Send contact cards | ✅ | | Send location | ✅ | -| Send buttons | ❌ | +| Send buttons | ❌ [(DEPRECATED)][deprecated-video] | | Send lists | ❌ [(DEPRECATED)][deprecated-video] | | Receive location | ✅ | | Message replies | ✅ | @@ -118,14 +120,17 @@ For further details on saving and restoring sessions, explore the provided [Auth | Kick group participants | ✅ | | Promote/demote group participants | ✅ | | Mention users | ✅ | +| Mention groups | ✅ | | Mute/unmute chats | ✅ | | Block/unblock contacts | ✅ | | Get contact info | ✅ | | Get profile pictures | ✅ | | Set user status message | ✅ | | React to messages | ✅ | -| Vote in polls | 🔜 | | Create polls | ✅ | +| Vote in polls | 🔜 | +| Communities | 🔜 | +| Channels | 🔜 | Something missing? Make an issue and let us know! From 77bed7be6e01fd5a52ba47d22b03bc59573da83e Mon Sep 17 00:00:00 2001 From: darkiii Date: Fri, 19 Apr 2024 08:54:25 +0200 Subject: [PATCH 4/5] text background-color --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 907768b07..a18105c1a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -
+

wwebjs.dev Guide


-

npm Depfu WhatsApp_Web 2.2346.52 Discord server

+
## About From 1269d76f5f19e2c8e3209f41c7838fe081a28624 Mon Sep 17 00:00:00 2001 From: qzdark Date: Fri, 19 Apr 2024 15:35:06 +0200 Subject: [PATCH 5/5] fix banner --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a18105c1a..0262a7d94 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -
+

- wwebjs.dev Guide + wwebjs.dev Guide