README.txt

   1
   2
   3
   4 *** SUNLIGHT CONGRESSIONAL DISTRICTS ***
   5
   6
   7
   8 ** ABOUT **
   9
  10 This module
  11 - Fetches data about the current members of Congress using the Sunlight Congress API.
  12     http://services.sunlightlabs.com/docs/Sunlight_Congress_API/
  13 - Provides an API for interfacing with Sunlight.
  14 - Exposes the members of Congress to the Views module.
  15 - With one of the contact integration modules (currently just CiviCRM Congressional Districts
  16   module) the congressional district of your contacts can be automatically determined.
  17 - Provides a form to search for members of Congress by ZIP.
  18
  19
  20 ** INSTALL **
  21
  22 1)Unpack the modules files just like any other Drupal module.  Probably at something like:
  23     sites/all/modules/contrib/cd_sunlight
  24
  25 2)Enable the Sunlight Congressional Districts module at
  26     admin/build/modules
  27   Do not enable CiviCRM Congressional Districts module at this time.
  28
  29 3)Configure the module at
  30     /admin/settings/cd_sunlight
  31   Specifically the Sunlight API key.
  32
  33 4)Visit the status report to see if the module is reporting any problems.
  34     /admin/reports/status
  35
  36 5)Proceed to the cd_civicrm/README.txt if you wish to integrate with CiviCRM.
  37
  38
  39
  40 ** VIEWS INTEGRATION **
  41
  42 To show information about members of Congress on your site you need to install the Views module.
  43   http://drupal.org/project/views
  44 You can find the default view called "Congress" at
  45   /admin/build/views
  46 You can either customize it or create a new view of the type "Congress".
  47
  48
  49
  50 ** USING THE API **
  51
  52 The API should only be used in situations where Views cannot be used.  In the future the Views
  53 integration will likely see more tending than the API.  Here are the API functions.  See the
  54 docbook comments for more info.
  55
  56 cd_sunlight_cd_parse_state($cd)
  57 cd_sunlight_cd_parse_district($cd)
  58 cd_sunlight_api_lookup_contact($contact)
  59 cd_sunlight_api_lookup($method, $params, &$error_message)
  60 cd_sunlight_contact_enqueue($storage_system, $contact_id)
  61 cd_sunlight_contact_dequeue($storage_system, $contact_id)
  62 cd_sunlight_bioguide_image_url($bioguide_id)
  63
  64
  65
  66 ** DEVELOPED BY **
  67
  68 Advomatic LLC
  69 http://advomatic.com
  70
  71
  72
  73 ** SPONSORED BY **
  74
  75 Democrats.com
  76 http://democrats.com