**************************************************************
*** Akismet for ExpressionEngine, a module/extension combo ***
**************************************************************


Version 1.1 - build 20061213 - by Lodewijk Schutte - http://loweblog.com/

Based on the WordPress plugin - http://akismet.com/download/


WHAT DOES IT DO?
----------------

* Check incoming comments

If a member leaves a comment, the comment is sent to the online Akismet service
at akismet.com. There it will be evaluated and a verdict of either 'spam' or
'okay' is sent back (this happens quicky, hardly any delay).

If a comment is considered 'spam', its status is set to 'closed'. If a comment
is considered 'okay', the comment is posted normally.

You can mark closed comments as either Spam (if Akismet was right) or Ham (if
Akismet was wrong). This is sent back to the Akismet service, so it can learn
from its mistakes, keeping commentspam to a bare minimum.

* Check incoming trackbacks

In the current version of Expression Engine (1.5.1) there is no native trackback
moderation algorithm. Rather than building this myself, this combo simply ignores
any trackback that Akismet considers to be spam. However, this means that there's
no record of a trackback being ignored. If and when the pMachine team decides to
add trackback moderation to EE, then I'll upgrade this combo to make use of that.


SYSTEM REQUIREMENTS
-------------------

This combo will only work with *ExpressionEngine 1.5.1 Build - 20061016*!
If you've got an earlier version of EE, you might consider version 0.1.0 of
this combo, which only checks your comments. Version 0.1.0 can be found in
the pMachine Forums: http://www.pmachine.com/forums/viewpost/165787/


NEW IN VERSION 1.1
------------------

* added option to moderate input if the Akismet server is unreachable (default: yes)


NEW IN VERSION 1.0
------------------

* added trackback checks
* added the setting "Check comments made by registered members" (default: no)
* added the setting "Check trackbacks" (default: yes)


INSTALLATION
------------

To use this combo, you'll need a WordPress API Key: http://wordpress.com/api-keys/
Once you've obtained one, you can continue with the installation.

- Unzip the files and upload them to your server
-- lang.akismet.php and lang.akismet_check.pgp go into your /system/language/english/ folder
-- ext.akismet_check.php goes into your /system/extensions/ folder
-- create a subfolder /akismet/ in your /system/modules/ folder
-- put both mod.akismet.php, mcp.akismet.php and index.html in that folder

- In your Control Panel, go to Admin -> Utilities -> Extensions Manager
- Make sure extensions are enabled
- Enable the extension 'Akismet Check'
- Click on 'Settings' for Akismet Check
- Fill in your API key and save

The extension should be working now. You now need to be able to mark caught comments
as spam or ham. For this, you need the module.

- In your Control Panel, go to Modules
- Install the Akismet module
- Click Akismet to open the module

Here you'll find a list of all the closed comments. You can either mark them as spam
and delete them, or mark them as ham and open them.


UPGRADE FROM EARLIER VERSION
----------------------------

- Unzip, upload and overwrite the files (see installation instructions)

- In your Control Panel, go to Admin -> Utilities -> Extensions Manager
-- Update the settings for the Akismet Check extension

- In your Control Panel, go to Modules -> Akismet
-- Upgrade the module by clicking on the upgrade link
