diff README @ 26:3c45a1bc40a5 0.5.0

update README for 0.5.0
author Yoshiki Yazawa <yaz@cc.rim.or.jp>
date Mon, 05 May 2008 20:59:15 +0900
parents 21f27858e155
children 73e817be3267
line wrap: on
line diff
--- a/README	Mon May 05 20:00:03 2008 +0900
+++ b/README	Mon May 05 20:59:15 2008 +0900
@@ -1,14 +1,19 @@
-pidgin-twitter-0.4.0
+pidgin-twitter-0.5.0
 
 
 1. What is this?
 
 pidgin-twitter is a pidgin plugin to help twittering via pidgin. This
-plugin translates an @username string and sender string to the link to
-the user, respectively. It also can play a sound when an incoming
-message contains any recipient name or sender name listed in the
-each dedicated lists.
+plugin translates any @username and the sender name to the link to the
+user respectively. pidgin-twitter also can play a sound when an
+incoming message contains any recipient name or sender name which is
+listed in the each dedicated lists.
 
+*update*
+From version 0.5.0, pidgin-twitter automatically escapes annoying
+"pseudo command" in sending message. A pseudo command is a message
+like "¤Ë¤Û¤ó¤´w" or "....w" and it will be wrongly interpreted as an
+incomplete command message so that twitter gives us an error massage.
 
 2. Dependency
 
@@ -26,25 +31,33 @@
 
 4. Usage
 
-To enable pidgin-twitter, please check it "Enabled" in pidgin plugins
-window. If it is enabled, it replaces sender and each @username string
-to the link to the corresponding user by default. You can
-enable/disable these via configure window.
+To enable pidgin-twitter, please check it "Enabled" in pidgin's
+plugins window. If it is enabled, it replaces each @username string
+and sender string with the link to the corresponding user, by
+default. You can enable/disable these via plugin's configure window.
 
 Play sound for matched recipients or sender is also enabled by
 default, however it might not work until you specify user lists for
-this feature. An user list is a enumeration of usernames separated by
-a letter in " ,:;". For example, "foo bar" or "foo,bar" is a valid
-user list. A list like "foo, bar" also works. Recipient list and
-sender list are independent to each other so that you can maintain
-different "watch list" for recipients and senders. This functionality
-is also able to be toggled respectively via configuration window.
+this feature.
+
+Recipient list accommodates names of watched recipients. Usually, the
+first name might be your user name. Sender list accommodates names of
+watched senders, instead.  These lists are independent to each other
+so that you can maintain different groups to be watched. An user list
+is a enumeration of usernames separated by a letter in ",:;". For
+example, "foo bar" or "foo,bar" is a valid user list and a list like
+"foo, bar" also works. This functionality is also able to be toggled
+on/off via configuration window.
 
 Event type of sound to play is also configurable. By default, the
-"Pounce Default" sound is specified as it may not be disabled by
-configuration in pidgin preferences. You can specify other sounds, but
-be aware, you have to enable the event type of sound you specified for
-pidgin-twitter in pidgin's preference.
+"Pounce Default" sound is specified since it may not be disabled by
+configuration in pidgin's preferences. You can specify other sounds,
+but be aware, you have to enable the event type of sound which you
+specified for pidgin-twitter in pidgin's preferences.
+
+Escape pseudo command functionality is enabled by default. To disable
+this feature, please uncheck it in the plugin configuration window. I
+recommend you to leave it always enabled.
 
 
 5. Acknowledgment