From 6bb07c7e59997d627bd9c0c7bb74d86d1bc0a4fc Mon Sep 17 00:00:00 2001 From: RomanBurunkov Date: Thu, 10 Dec 2020 14:05:09 +0000 Subject: [PATCH] Add events details onto readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1141010..2c6719b 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,16 @@ The following options are available: * host - mpd service host, default value is 'localhost'. * port - mpd service TCP port, default value is 6600. +Events +------ + +* ready - Emits after connected to the MPD service. +* error - Emits when any errors occured. +* update - Emits when got any updates from MPD service. +* status - Emits when MPD service status has been updated. +* disconnected - Emits after disconnecting from MPD service. + + Example ------ This is a minimal exmaple which connects to a mpd running on localhost on the default port and prints the current playlist: