// $Id: README.txt 80 2009-12-02 17:55:59Z JosefBiechele $


DESCRIPTION
---------------
IS24 provides a bridge to the API of ImmobilienScout24.de (is24.de),
an internet portal for real estates widely used by german estate agencies.

The module 

   * displays all or selected estate offers from is24.de in a drupal block
   * let you configure the search options, sort order and the appearance 
     of the block
   * links the displayed offers to the is24.de synopsis ("expose") page 


To use the module productively you have to be registered with is24.de.
Request your API key and get your Vendor ID. 

For test purposes you can get a free API key from is24.de and use the 
test Vendor ID 6687764.


INSTALLATION
---------------
Put the module in your drupal modules directory and enable it in 
admin/build/modules. 


CONFIGURATION
---------------
1. Go to admin/settings/is24 and specify your is24.de
   * API key 
   * Vendor ID

Visit is24.de to request an API key. 
For test purposes you can use the test Vendor ID 6687764.

2. Go to admin/build/block and enable the block "ImmobilienScout24.de Estate Offers" 
Configure it after your fancy. Available configuration options are:
   
   * Number of items to display
   * Estate type(s), "all" or (multi-) selected 
   * Select the type of image to display
   * Sort criterias
   * Sort order
   * Display or not the heading of an offer
   * Display or not an image of the offer if available


AUTHOR/MAINTAINER
---------------
- josef biechele
jbiechele AT takeaweb DOT com

