diff --git a/plugins/Alias/README.md b/plugins/Alias/README.md index cb4269571..f8d0eed59 100644 --- a/plugins/Alias/README.md +++ b/plugins/Alias/README.md @@ -6,18 +6,22 @@ nested commands are not immediately run. Basic usage ----------- -Add an alias, trout, which expects a word as an argument +Add an alias, `trout`, which expects a word as an argument +``` @alias add trout "action slaps $1 with a large trout" jamessan: The operation succeeded. @trout me * bot slaps me with a large trout +``` -Add an alias, lastfm, which expects a last.fm user and replies with +Add an alias, `lastfm`, which expects a last.fm user and replies with their recently played items. +``` @alias add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]" +``` Note that if the nested commands being aliased hadn't been quoted, then -those commands would have been run immediately, and @lastfm would always +those commands would have been run immediately, and `@lastfm` would always reply with the same information, the result of those commands.