From e50151d0c611a931ec93f76849776f2bed3576a0 Mon Sep 17 00:00:00 2001 From: Jeena Paradies Date: Mon, 21 Dec 2009 22:52:44 +0100 Subject: [PATCH] added a little bit of documentation --- colloquy_lastfm_plugin.js | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/colloquy_lastfm_plugin.js b/colloquy_lastfm_plugin.js index 80321f1..c6af37a 100644 --- a/colloquy_lastfm_plugin.js +++ b/colloquy_lastfm_plugin.js @@ -1,3 +1,23 @@ +/** + * This Colloquy plugin posts a + * "/me is listening to ..." into the chanel you are + * talking on in IRC. + * + * Save this plugin into: + * ~/Library/Application Support/Colloquy/PlugIns/colloquy_lstfm_plugin.js + * + * Restart Colloquy to load the plugin (/reload plugins doesn't always work). + * + * Usage: + * /lastfm help => to show the help + * /lastfm username => to set user last.fm username (e.g.: /lastfm johndoe) + * /lastfm getusername => to see your default last.fm username + * + * Autoho Jeena Paradies + * This plugin is public domain. + * This plugin is OS X Colloquy only. + */ + function processUserCommand( command, arguments, connection, view ) { if(command.toLowerCase() == "lastfm") { @@ -103,4 +123,4 @@ function processUserCommand( command, arguments, connection, view ) { } return false; -} \ No newline at end of file +}