From dc5423d1d8848501f253739e80b3a343df2009af Mon Sep 17 00:00:00 2001 From: dahlinomine <132731075+dahlinomine@users.noreply.github.com> Date: Fri, 27 Mar 2026 08:55:43 +0000 Subject: [PATCH] docs: add Getting Started section to README --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e03620..0128c86 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,22 @@ This is the website for wwebjs.dev and the guide for the [whatsapp-web.js](wwebj * [GitHub][gitHub] * [npm][npm] +## Getting Started + +To run this website locally for development: + +1. Clone the repository: `git clone https://github.com/wwebjs/wwebjs.dev.git` +2. Install dependencies: `npm install` +3. Start the development server: `npm run dev` +4. Open your browser at `http://localhost:8080` + ## Contributing -Everyone is welcome to contribute to this guide and help us improve it. Please take a moment to review the [guidelines for contributing][contributing] first, befor creating a pull request. Don't rush a contribution, test changes locally, make sure you're doing it correctly and then submit a pull request. Ideas for you first contribution can be found in the issue label [good first issue][good-first-issue] or in the [To-Do section][todo]. +Everyone is welcome to contribute to this guide and help us improve it. Please take a moment to review the [guidelines for contributing][contributing] first, before creating a pull request. Don't rush a contribution, test changes locally, make sure you're doing it correctly and then submit a pull request. Ideas for you first contribution can be found in the issue label [good first issue][good-first-issue] or in the [To-Do section][todo]. ## Help -If you experiencing issues with the guide in understaning, please open an issue or ask on [Discord][discord] for help. +If you experiencing issues with the guide in understanding, please open an issue or ask on [Discord][discord] for help. [wwebjs]: https://github.com/pedroslopez/whatsapp-web.js [website]: https://wwebjs.dev @@ -52,4 +61,4 @@ If you experiencing issues with the guide in understaning, please open an issue [contributing]: https://github.com/wwebjs/wwebjs.dev/tree/candy/.github/CONTRIBUTING.md [good-first-issue]: https://github.com/wwebjs/wwebjs.dev/contribute [todo]: https://github.com/wwebjs/wwebjs.dev/projects/1 -[discord]: https://discord.gg/H7DqQs4 +[discord]: https://discord.gg/H7DqQs4 \ No newline at end of file