Add usage info to readme

This commit is contained in:
Inex Code 2020-11-03 13:47:02 +00:00
parent 25a85d1a2b
commit 3b9f63d67c

View file

@ -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 <vk token>`
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.