@alex_rexby/n8n-nodes-max 0.4.21 → 0.4.23

package/README.md

@@ -1,119 +1,163 @@
 # n8n-nodes-max
 
-This is an n8n community node for MAX messenger API integration.
+This is an n8n community node for [MAX Messenger](https://max.team/) API integration.
 
-n8n is a fair-code licensed workflow automation platform.
+![MAX Messenger](https://max.team/favicon.ico)
+
+[MAX](https://max.team/) is a Russian messenger platform. This node allows you to interact with MAX Messenger API directly from n8n workflows.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
 
 ## Installation
 
-Follow the installation guide in the n8n community nodes documentation.
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+### Quick Install
 
-1. Go to **Settings > Community Nodes**
-2. Click **Install**
+1. Go to **Settings** > **Community Nodes** in your n8n instance
+2. Select **Install**
 3. Enter `@alex_rexby/n8n-nodes-max`
 4. Click **Install**
 
-Or install via npm in your n8n installation:
+Or install via npm:
 
     npm install @alex_rexby/n8n-nodes-max
 
-## Operations
-
-### Message Resource
-
-* **Send Text** - Send a text message to a user
-* **Send with Media** - Send message with file (image, video, audio, document)
-* **Get** - Get a message by ID
-* **Edit** - Edit an existing message
-* **Delete** - Delete a message
-
-### Bot Resource
-
-* **Get Info** - Get information about your bot
-
-### Chat Resource
-
-* **Update** - Update chat information (title, description)
-
-### Callback Resource
-
-* **Answer** - Answer callback query (button click notification)
-* **Answer and Send Message** - Answer callback and send a new message
-
-### Webhook Trigger
-
-* **MAX Trigger** - Receive webhooks from MAX messenger (messages, callbacks, etc.)
-
 ## Credentials
 
-You need to create a MAX Bot and get an API token:
-
-1. Contact @maxbot in MAX messenger
-2. Create a new bot and get the API token
-3. In n8n, create new credentials for MAX API
-4. Enter your bot token
-
-## Usage
-
-### Send a Simple Message
+You need a **MAX Bot Token** to use this node.
 
-1. Add **MAX** node to your workflow
-2. Select credentials
-3. Choose **Message** → **Send Text**
-4. Enter User ID
-5. Enter your message text
+1. Create a bot via [MAX Bot API](https://dev.max.ru/docs/chatbots/)
+2. Get your bot token
+3. In n8n, create a new credential:
+   - Type: **MAX API**
+   - Token: Your bot token
 
-### Send Message with Image
+## Operations
 
-1. Download/prepare image in previous node
-2. Add **MAX** node
-3. Choose **Message** → **Send with Media**
-4. Enter User ID
-5. Set Binary Property (usually `data`)
-6. Add caption (optional)
+### MAX Node
+
+**Resources:**
+- **Message**
+  - Send Text - Send text message to user or channel
+  - Send with Media - Send message with file (image, video, audio, document)
+  - Get - Get message by ID
+  - Edit - Edit existing message
+  - Delete - Delete message
+  
+- **Bot**
+  - Get Info - Get bot information
+  
+- **Chat**
+  - Update - Update chat information (title, description)
+  
+- **Callback**
+  - Answer - Answer callback query (inline button click)
+  - Answer and Send Message - Answer callback and send a new message
+
+**Features:**
+- ✅ Send messages to **users** (user_id) or **channels/groups** (chat_id with `-` prefix)
+- ✅ Inline keyboard buttons (simple visual builder or advanced JSON)
+- ✅ File attachments (images, videos, audio, documents)
+- ✅ Message formatting (Markdown, HTML)
+- ✅ Reply to messages
+- ✅ Silent messages
+- ✅ Disable link preview
+
+### MAX Trigger Node
+
+Webhook-based trigger for receiving events from MAX Messenger.
+
+**Event Modes:**
+- **All Events** - Receive all events from MAX API (recommended for testing)
+- **Specific Events** - Filter by event types:
+  - Message Created
+  - Message Callback (inline button clicks)
+  - Bot Started
+
+**Usage:**
+1. Add MAX Trigger node to your workflow
+2. Configure credentials
+3. Select event mode
+4. Activate workflow
+5. Webhook URL will be automatically registered with MAX API
+
+## Examples
+
+### Send Text Message to User
+
+User ID: `4624138`  
+Text: `Hello from n8n!`
+
+### Send Message to Channel
+
+User ID / Chat ID: `-70931657203722`  
+Text: `New announcement!`
+
+### Send Image with Caption
+
+User ID: `4624138`  
+Binary Property: `data`  
+Caption: `Check out this image!`
 
 ### Send Message with Buttons
 
-1. Add **MAX** node
-2. Choose **Message** → **Send Text** (or **Send with Media**)
-3. Enable **Add Buttons**
-4. Choose **Simple (Visual)** mode
-5. Add button rows and configure buttons
-
-### Receive Webhooks (Trigger)
+User ID: `4624138`  
+Text: `Choose an option:`  
+Add Buttons: `true`  
+Button Mode: `Simple (Visual)`
 
-1. Add **MAX Trigger** node
-2. Select credentials
-3. Copy the webhook URL
-4. Set it in your bot settings via MAX API
-5. Workflow will trigger on incoming events
+**Button 1:**
+- Text: `Option A`
+- Type: `Callback`
+- Callback Data: `option_a`
 
-### Handle Button Clicks
+**Button 2:**
+- Text: `Visit Website`
+- Type: `Link`
+- URL: `https://example.com`
 
-1. Use **MAX Trigger** to receive callback queries
-2. Filter by event type: `callback_query`
-3. Use **MAX** → **Callback** → **Answer** to acknowledge
-4. Optionally send a new message
+### Webhook Trigger Example
 
-## Example Workflows
+1. Add MAX Trigger node
+2. Select "All Events"
+3. Connect to IF node to filter by `update_type`
+4. Process different event types accordingly
 
-**Echo Bot**
+## Compatibility
 
-    MAX Trigger → MAX (Send Text)
+- n8n version: 1.0.0+
+- Tested with n8n 2.1.4
 
-**Image Processing Bot**
+## Resources
 
-    MAX Trigger → HTTP Request (download) → Edit Image → MAX (Send with Media)
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [MAX API Documentation](https://dev.max.ru/docs-api/)
+* [MAX Bot Platform](https://dev.max.ru/docs/chatbots/)
 
-**Interactive Menu**
+## Version History
 
-    MAX (Send Text with Buttons) → MAX Trigger (callback) → Switch → MAX (Answer and Send)
+### 0.4.20
+- Fixed media upload (multipart/form-data support)
+- Added support for channels/groups (chat_id with `-` prefix)
+- Added "All Events" mode to MAX Trigger
+- Improved webhook management
 
-## Resources
+### 0.4.15
+- Added Send with Media operation
+- Support for image, video, audio, and file attachments
 
-* n8n community nodes documentation: https://docs.n8n.io/integrations/community-nodes/
-* MAX API Documentation: https://dev.max.ru/
+### 0.4.0
+- Initial release
+- Basic message operations
+- Webhook trigger support
+- Inline keyboard buttons
 
 ## License
 
-MIT
+[MIT](LICENSE.md)
+
+## Support
+
+- Report issues on GitHub
+- MAX API Help: [MAX Developer Portal](https://dev.max.ru/)