Browse Source

chore: docs update

pull/301/head
Aldino Kemal 10 months ago
parent
commit
13c42c1184
  1. 9
      readme.md

9
readme.md

@ -20,6 +20,14 @@ Download:
- [Release](https://github.com/aldinokemal/go-whatsapp-web-multidevice/releases/latest) - [Release](https://github.com/aldinokemal/go-whatsapp-web-multidevice/releases/latest)
- [Docker Image](https://hub.docker.com/r/aldinokemal2104/go-whatsapp-web-multidevice/tags) - [Docker Image](https://hub.docker.com/r/aldinokemal2104/go-whatsapp-web-multidevice/tags)
## Breaking Changes
- `v6`
- For REST mode, you need to run `<binary> rest` instead of `<binary>`
- for example: `./whatsapp rest` instead of ~~./whatsapp~~
- For MCP mode, you need to run `<binary> mcp`
- for example: `./whatsapp mcp`
## Feature ## Feature
- Send WhatsApp message via http API, [docs/openapi.yml](./docs/openapi.yaml) for more details - Send WhatsApp message via http API, [docs/openapi.yml](./docs/openapi.yaml) for more details
@ -177,6 +185,7 @@ services:
volumes: volumes:
- whatsapp:/app/storages - whatsapp:/app/storages
command: command:
- rest
- --basic-auth=admin:admin - --basic-auth=admin:admin
- --port=3000 - --port=3000
- --debug=true - --debug=true

Loading…
Cancel
Save