diff --git a/README.md b/README.md index e0ad46c..83aff14 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,29 @@ 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 (LTS version recommended) +- 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 +115,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**.