From 41305924d997dc9d89b5c365d0e673d908075ff2 Mon Sep 17 00:00:00 2001 From: Sayani Chatterjee Date: Fri, 23 Jan 2026 00:14:38 +0530 Subject: [PATCH 1/2] docs: fix typos and improve setup instructions --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0ad46c..3ad3813 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,30 @@ Admins can configure the AI Guide Agent to deliver a streamlined onboarding and
  • They can simply use the chat interface to carry out tasks like creating, joining, or leaving a channel, inviting users, or using app functions , all without needing to know the inner workings or remember slash commands.
  • + +## ✅ Prerequisites + +Before installing the app, make sure you have: + +- Node.js (v18 or later recommended) +- npm (comes with Node.js) +- Rocket.Chat server (local or remote) +- Rocket.Chat Apps CLI installed globally + +> **Note for Windows (PowerShell users):** +> Use quotes when installing the Apps CLI: +> ```powershell +> npm install -g "@rocket.chat/apps-cli" +> ``` + +

    ⚙️ Installation

    1. Have a Rocket.Chat server ready. If you don't have a server, see this guide.
    2. -
    3. Install the Rocket.Chat Apps Engline CLI. +
    4. Install the Rocket.Chat Apps Engine CLI. ``` @@ -99,6 +116,12 @@ rc-apps deploy --url --username --password
    + +> This is a Rocket.Chat App and does not run using `npm start`. +> The app is deployed and executed inside a Rocket.Chat server using the Apps CLI. + + + ## 🧑‍💻 Contributing Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. From c22a174bdbd881b31a4bba198a7b8459ff83e020 Mon Sep 17 00:00:00 2001 From: Sayani Chatterjee Date: Mon, 26 Jan 2026 00:56:14 +0530 Subject: [PATCH 2/2] docs: align prerequisites with review feedback --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ad3813..83aff14 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,7 @@ Admins can configure the AI Guide Agent to deliver a streamlined onboarding and Before installing the app, make sure you have: -- Node.js (v18 or later recommended) -- npm (comes with Node.js) +- Node.js (LTS version recommended) - Rocket.Chat server (local or remote) - Rocket.Chat Apps CLI installed globally