From 3b9f63d67c00d5e50695ce3f05e5cc6419a5dc26 Mon Sep 17 00:00:00 2001 From: Inex Code Date: Tue, 3 Nov 2020 13:47:02 +0000 Subject: [PATCH] Add usage info to readme --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9b1039..7acc176 100755 --- a/README.md +++ b/README.md @@ -12,5 +12,32 @@ npm run build Next copy the `sample.config.yaml` to `config.yaml`, edit it and then run `npm run start -- -r` to generate a registration file. Register that one with synapse and start the bridge with `npm run start`. +## Features and roadmap +- Matrix -> VK + - [x] Text content + - [ ] Image content + - [ ] Audio/Video content + - [ ] Other files + - [ ] Replies + - [ ] Typing notifs + - [ ] Presence + - [ ] Read notifications +- VK -> Matrix + - [x] Text content + - [ ] Image content + - [ ] Audio/Video content + - [ ] Stickers + - [ ] Other files + - [ ] Presence + - [x] Typing notifs + - [x] User profiles + - [ ] Read notifications + ## Usage -TODO +1. Get VK community token (Just open the "Manage community" tab, go to "API usage" tab and click "Create token") +2. Activate Bots Long Poll API ("Manage community" → "API usage" → "Bots Long Poll API") and choose the latest API version. Make sure that under event types all message-realted events are turned on. +3. Activate an option to message your community. To allow group chats, activate it under bot capabilities. +4. On matrix, contact `@_vk_puppet_bot:your.domain` and type `link ` +5. Now, if someone contacts your community, you will be invited to the corresponding room on Matrix. + +Plese note: when community is invited to the group chat as a bot, make sure it has message access. Only chat admins can change bot permissions.