Skip to content

Commit 689c25a

Browse files
committed
chore: update README.md
Signed-off-by: Edward Ly <[email protected]>
1 parent f43a365 commit 689c25a

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
## Nextcloud Assistant Talk Bot
22

3-
**A talk bot using [`AppAPI`](https://github.com/nextcloud/app_api), Task Processing API, and Talk Bot API.**
4-
5-
> **Note:**
6-
> The `AppAPI` application needs to be enabled to install and use this bot.
3+
**A talk bot using [`AppAPI`], Task Processing API, and Talk Bot API.**
74

85
The bot answers questions in chat based on the model set by Nextcloud Assistant.
96

107
## How to install:
118

12-
1. Set up a deployment daemon by following the [AppAPI instructions](https://nextcloud.github.io/app_api/CreationOfDeployDaemon.html). _(Automatically created with AIO)_
13-
2. Go to the `Apps` menu in Nextcloud, find this app (`Assistant Talk Bot`) in the `Tools` category, and click `Deploy and Enable`.
14-
3. In Nextcloud Talk, open a conversation and activate the bot in `Conversation settings`.
15-
4. Invoke the bot by typing `@assistant` followed by your question (e.g., `@assistant I have a question for you.`).
9+
1. Install [`AppAPI`]
10+
and set up a deploy daemon by following the [AppAPI instructions].
11+
_(Automatically created with AIO)_
12+
2. Go to the `Apps` menu in Nextcloud,
13+
find this app (`Assistant Talk Bot`) in the `Tools` category,
14+
and click `Deploy and Enable`.
15+
3. In Nextcloud Talk,
16+
open a conversation and enable the bot in `Conversation settings`.
17+
4. Invoke the bot by typing `@assistant` followed by your question
18+
(e.g., `@assistant I have a question for you.`).
19+
20+
<!-- Links -->
21+
22+
[`AppAPI`]: https://github.com/nextcloud/app_api
23+
[AppAPI instructions]: https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/AppAPIAndExternalApps.html

0 commit comments

Comments
 (0)