Skip to content

Add prereqs section in docs #38

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

Merged
dodaa08 merged 1 commit into from
Sep 18, 2026
Merged

Add prereqs section in docs #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ Connect your Rocket.Chat server directly to OpenClaw agents—no bridge server n
[View on ClawHub](https://clawhub.ai/plugins/@dodaa08/openclaw-plugin-test)
</div>

## Prerequisites
## Prerequisites & Cross-Platform Support

- A Rocket.Chat server (with admin access)
- OpenClaw installed and configured with an AI provider
- A default agent already set up
This plugin is fully cross-platform and runs on **Linux, macOS, and Windows**.

- **Node.js**: `v22+`
- **OpenClaw Core**: `v2026.7+`
- **Rocket.Chat Server**: Any modern Rocket.Chat release (self-hosted or cloud) with admin access
- **AI Provider**: OpenClaw configured with a primary AI provider & default agent (`main`)

> **Having issues?** Check [`openclaw.examples.json`](./openclaw.examples.json) in the repo root for a complete annotated configuration reference. You can also manually edit `~/.openclaw/openclaw.json` if needed.

Expand Down
4 changes: 1 addition & 3 deletions docs/SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ How to install, configure, and manage credentials for the Rocket.Chat plugin.

## Prerequisites

- Rocket.Chat server with admin access (needed once, during setup)
- OpenClaw installed with AI provider configured
- A default agent already set up
See [Prerequisites & Cross-Platform Support](../README.md#prerequisites--cross-platform-support)

## Quick Start

Expand Down
Loading