Changeset 727 for trunk/PostOffice

Show
Ignore:
Timestamp:
06/13/08 00:45:34 (18 months ago)
Author:
breese
Message:

updated readme

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/PostOffice/README.txt

    r675 r727  
    1 ############################################################# 
    2 This is a placeholder README. 
    3 If you are the author, please fill in the __sections__ below. 
    4 If you are not the author, please bug the author. 
    5 ############################################################# 
     1## PostOffice, a plugin for Movable Type 
     2## Author: Six Apart, http://www.sixapart.com/ 
     3## Version: 1.0 
     4## Released under GPL2 
     5## 
    66 
    7 ## __PLUGINNAME__, a plugin for Movable Type 
    8 ## Author: __AUTHORNAME__, __EMAIL/URL__ 
    9 ## Version: __VERSION__ 
    10 ## Released under __LICENSE__ 
    11 ## 
    12 ## $Id$ 
    13   
    147## OVERVIEW ## 
    158 
    16 __A short and very basic description of the plugin.__ 
     9This plugin enables users to post to their blog via email. 
    1710 
    1811## PREREQUISITES ## 
    1912 
    20 __detail MT version compatibility and anything else the plugin requires__ 
     13* Mail::IMAPClient (for IMAP) 
     14* Mail::POP3Client (for POP) 
     15* Email::Address 
     16* Email::MIME 
     17* IO::Socket::SSL 
    2118 
    2219## FEATURES ## 
    2320 
    24 __A longer description of the plugin's features for those who are still reading__ 
     21Post Office is a plugin for Movable Type that allows users to post to  
     22their blog via email. It works by connecting Movable Type to an  
     23existing email account, like GMail or any POP or IMAP compliant mailbox,  
     24and periodically scanning for messages to post. Each user can be given  
     25a unique email address to which to post to uniquely identify them and  
     26the blog they want to post to when sending an email.  
    2527 
    2628## INSTALLATION ## 
    2729 
    28 __detail installation instructions__ 
    29  
    30 ## CONFIGURATION ## 
    31  
    32 __detail configuration instructions, if any__ 
    33  
    34 ## USAGE ## 
    35  
    36 __detail further usage instructions, if any__ 
    37  
    38 ## KNOWN ISSUES ## 
    39  
    40 __detail any known issues with current version, if any__ 
     30  1. Copy the contents of PostOffice/plugins into /path/to/mt/plugins/ 
     31  2. Navigate to the settings area for PostOffice and enter in the 
     32     connection info for your email provider. 
     33  3. Ensure that you have an API Password selected for yourself. Edit 
     34     your profile if you need to select one. 
     35  4. Click the Write Entry button and scroll to the bottom of the screen. 
     36     Look for the text "Email to <blog name>". 
     37  5. Save the email address linked to in your address book. Send a test 
     38     email. 
    4139 
    4240## SUPPORT ## 
    4341 
    44 __specify where people can go for support__ 
     42For support, please visit our forums: 
     43 
     44   http://forums.movabletype.org/ 
    4545 
    4646## SOURCE CODE ## 
    … …  
    4949 
    5050SVN Repo: 
    51     http://code.sixapart.com/svn/mtplugins/trunk/__PLUGINNAME__ 
     51    http://code.sixapart.com/svn/mtplugins/trunk/PostOffice 
    5252 
    5353Trac View: 
    54     http://code.sixapart.com/trac/mtplugins/log/trunk/__PLUGINNAME_ 
     54    http://code.sixapart.com/trac/mtplugins/log/trunk/PostOffice 
    5555 
    5656Plugins: 
    57     http://plugins.movabletype.org/__PLUGIN__ 
     57    http://plugins.movabletype.org/post-office/ 
    5858 
    5959 
    6060## LICENSE ## 
    6161 
    62 __specify the license the plugin is released under__ 
     62GPL 2.0 
    6363 
    6464## AUTHOR ## 
    6565 
    66 __insert arbitrary author info, e.g name, email, URL, company, etc__ 
     66Copyright 2008, Six Apart, Ltd. All rights reserved.