diff --git a/README.md b/README.md index e0ad46c..e36d62c 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Admins can configure the AI Guide Agent to deliver a streamlined onboarding and
  • Have a Rocket.Chat server ready. If you don't have a server, see this guide.
  • -
  • Install the Rocket.Chat Apps Engline CLI. +
  • Install the Rocket.Chat Apps Engine CLI. ``` @@ -99,6 +99,45 @@ rc-apps deploy --url --username --password +## ⚡ Quickstart (Test Locally) + +Once you've installed the app, follow these steps to test it in your Rocket.Chat workspace: + +1. **Start a Rocket.Chat server** + - Use a local development server (`http://localhost:3000`) or an existing cloud workspace + - Ensure you have **admin access** to install apps + +2. **Enable Apps development mode** + - Go to **Administration > General > Apps** + - Turn on **"Enable development mode"** + +3. **Deploy the app** + Run this command from the project root: + ```bash + rc-apps deploy --url http://localhost:3000 --username --password + ``` + Replace `` and `` with your admin credentials. + +4. **Activate the app** + - Navigate to **Administration > Marketplace > Private Apps** + - You should see **"AI Server Guide Agent"** listed + - Click on it and enable the app + +5. **Test with a new user** + - Create a test user account or ask a new team member to join + - The bot will automatically: + - Send a welcome message + - Show server rules & etiquette + - Recommend channels based on their needs + - Auto-join them to default channels + +6. **Try admin commands** + As an admin, test these features in chat: + - Broadcast announcements to users/channels + - Execute slash commands via the chat interface + - Manage channel recommendations + + ## 🧑‍💻 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**.