Mercurial > pidgin-twitter

changeset 189:5cf6cd93d928

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- fix typo and add some minor change - unify expressions as: - pidgin -> Pidgin - twitter -> Twitter - wassr -> Wassr
author mojin <truffechampagne@gmail.com>
date Tue, 05 Aug 2008 21:57:56 +0900
parents 275872001d52
children 3c7dfd65e728
files README
diffstat 1 files changed, 43 insertions(+), 40 deletions(-) [+]
line wrap: on
line diff
--- a/README	Tue Aug 05 20:24:16 2008 +0900
+++ b/README	Tue Aug 05 21:57:56 2008 +0900
@@ -3,7 +3,7 @@
 
 1. What is this?
 
-pidgin-twitter is a pidgin plugin to help posting and reading micro
+pidgin-twitter is a Pidgin plugin to help posting and reading micro
 blogs such as Twitter. Currently, pidgin-twitter supports Twitter,
 Wassr and identi.ca.
 
@@ -16,7 +16,7 @@
     * show letter counter on the format toolbar
 
 Twitter specific
-    * get/post twitter statuses via API
+    * get/post Twitter statuses via API
     * escape pseudo commands like "w"
     * suppress oops message return
 
@@ -30,7 +30,7 @@
 
 2. Dependency
 
-This plugin requires pidgin 2.4.0 or newer, glib-2.14.0 or newer and
+This plugin requires Pidgin 2.4.0 or newer, glib-2.14.0 or newer and
 libxml-2.6.27 or newer.
 
 
@@ -45,7 +45,7 @@
 
 4. Usage
 
-To enable pidgin-twitter, please check it as "Enabled" in pidgin's
+To enable pidgin-twitter, please check it as "Enabled" in Pidgin's
 plugins window. Almost all of features can be configured through
 pidgin-twitter's paged preferences window. In this section, we explain
 the features in page by page basis.
@@ -55,27 +55,29 @@
 4.1.1 Screen Name
 
 You can specify your account names for each service here. These names
-will be used for showing your icon in conversations. In a twitter
+will be used for showing your icon in conversations. In a Twitter
 conversation, the screen name will be also used for authentication
 when API based access is enabled.
 
 4.1.2 Get/post statuses via API
 
-Since pidgin is an instant message client, it is natural that pidgin
-uses XMPP protocol to access twitter. However, twitter has suspended
+Since Pidgin is an instant message client, it is natural that Pidgin
+uses XMPP protocol to access to Twitter. However, Twitter has suspended
 their IM gateway for long time, for maintenance reason. So we had
-decided to provide the other way to access to twitter using twitter's
+decided to provide the other way to access to Twitter using Twitter's
 public API.
 
-If you enables this feature, pidgin-twitter gets your timeline and put
-your update via twitter API.
+If you enable this feature, pidgin-twitter gets your timeline and puts
+your update via Twitter API.
 
 4.1.3 Password
 
-This password is used for basic authentication which is required to
-access twitter via API. Note that the twitter password is saved in
-configuration file, e.g. ~/.purple/prefs.xml, as plain text and sent
-to twitter API without encryption.
+Please put your Twitter password here if you have enabled "Get/post
+statuses via API" checkbox (see 4.1.2).  This password is used for
+basic authentication which is required to access Twitter via API. Note
+that the Twitter password is saved inconfiguration file,
+e.g. ~/.purple/prefs.xml, as plain text and sent to Twitter API
+without encryption.
 
 4.1.4 Retrieve interval
 
@@ -111,7 +113,7 @@
 4.3.3 Enable update
 
 This checkbox toggles update for icons by the specified period. See
-bellow for the period.
+below for the period.
 
 4.3.4 Update period
 
@@ -135,72 +137,72 @@
 4.4.2 Recipient list
 
 Recipient list accommodates names of watched recipients. This 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
+a enumeration of usernames separated by a letter in ",:;" and spaces. 
+For example, "foo bar" or "foo,bar" is a valid user list and a list like
 "foo, bar" also works.
 
 4.4.3 Sound type
 
-You can specify Event type of sound to play here. The "Pounce Default"
+You can specify event type of sound to be played here. The "Pounce Default"
 sound is the default sound type because it may not be disabled by
-configuration in pidgin's preferences. You can specify other sounds,
+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.
+specified for pidgin-twitter in Pidgin's preferences.
 
 4.4.4 Play sound on a message from a specified sender
 
-This is same to 4.4.1 except that it is for senders.
+This is same as 4.4.1 except that it is for senders.
 
 4.4.5 Sender list
 
-This is same to 4.4.2 except that sender list accommodates names of
+This is same as 4.4.2 except that sender list accommodates names of
 watched senders.
 
 4.4.6 Sound type
 
-This is same to 4.4.3 except that it is for senders.
+This is same as 4.4.3 except that it is for senders.
 
 4.5 Utility page
 
 4.5.1 Show text counter
 
 This checkbox toggles letter counter. If it is enabled, a small letter
-counter widget will appear on the format bar in a pidgin conversation
+counter widget will appear on the format bar in a Pidgin conversation
 window. This counter keeps track of length of composing string in
 character. Each service has its own limit of length for posting
-messages; 140 characters in twitter, 255 characters in wassr and 140
-bytes in identi.ca. If the composing message exceeds limit, the
+messages; 140 characters in Twitter, 255 characters in Wassr and 140
+bytes in identi.ca. If the composing message exceeds the limit, the
 displayed number will turn red to notify you the excess.
 
-4.5.2 Escape pseudo command for twitter
+4.5.2 Escape pseudo command for Twitter
 
 This checkbox toggles escape pseudo command functionality.
 
 A pseudo command is a message composed of leading non Latin string and
 trailing an alphabet letter which can be interpreted as a command in
 short form. Twitter wrongly interpreted it as an incomplete command
-message so that twitter gives you an error massage.
+message so that Twitter gives you an error massage.
 
 If this feature is enabled, pidgin-twitter automatically escapes any
 pseudo command by prepend ". " at the beginning of a message.
 
 4.5.3 Suppress oops message
 
-This checkbox toggles suppress oops message feature for twitter
+This checkbox toggles suppress oops message feature for Twitter
 conversation.
 
 This feature may require explanation. If we send a message which is
-longer than 140 bytes, twitter will send us back an oops message to
-notify the excess of the limit. However, twitter computes the actual
+longer than 140 bytes, Twitter will send us back an oops message to
+notify the excess of the limit. However, Twitter computes the actual
 hard limit in internal representation of characters so that the
-messages which does not exceed 140 letters will actually be
-accepted. This feature will silently discards *false* oops message in
+messages which does not exceed 140 letters can actually be
+accepted. This feature will silently discard *false* oops message in
 this situation.
 
 4.5.4 Do not notify incoming message (Windows only)
 
-Suppress blinking Pidgin's task bar button for new incoming message 
-when Pidgin window is not active. 
+This checkbox toggles suppression of blinking Pidgin's task bar button 
+for new incoming message when Pidgin window is not active. 
 
 4.5.5 Output log message
 
@@ -235,17 +237,17 @@
 - Show icon feature has been added.
 - API based posting has been added.
 - Notification on message arrival can be disabled now.
-- Annoying completion message which is returned from wassr service
+- Annoying completion message which is returned from Wassr service
   will be automatically ignored.
 
 0.7.0 (August 5 2008)
 - Support for identi.ca has been added.
-- Icon support for wassr and identi.ca have been added.
+- Icon support for Wassr and identi.ca have been added.
 - Icon size and icon visibility are now configurable.
 - Automatic icon update has been implemented.
-- Translation from channel name to the link to the channel in wassr
+- Translation from channel name to the link to the channel in Wassr
   has been added.
-- Disabling notification on message arrival now works for wassr and
+- Disabling notification on message arrival now works for Wassr and
   identi.ca too.
 
 6. Acknowledgments
@@ -263,7 +265,8 @@
 API based posting has been contributed by nosuke in development for
 0.7.0.
 
-We got uncountable feedbacks from users in the #pidgin_twitter channel.
+We got uncountable feedbacks from users in the #pidgin_twitter channel 
+at Wassr.  
 
 Yoshiki Yazawa (@yazuuchi) and the pidgin-twitter team
 yaz@honeyplanet.jp