Skip to content

docs: fix typos and improve setup instructions #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sayani1309 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix typos and improve setup instructions #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4130592
docs: fix typos and improve setup instructions
Sayani1309 Jan 22, 2026
c22a174
docs: align prerequisites with review feedback
Sayani1309 Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,29 @@ Admins can configure the AI Guide Agent to deliver a streamlined onboarding and
<li>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.</li>
</ul>


## ✅ 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"
> ```


<h2 >⚙️ Installation </h2>

<ol>

<li>Have a Rocket.Chat server ready. If you don't have a server, see this <a href="https://developer.rocket.chat/v1/docs/server-environment-setup">guide</a>.</li>

<li>Install the Rocket.Chat Apps Engline CLI.
<li>Install the Rocket.Chat Apps Engine CLI.

```

Expand Down Expand Up @@ -99,6 +115,12 @@ rc-apps deploy --url <server_url> --username <username> --password <password>

</ol>


> 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**.
Expand Down