modification of README file
[project/zendesk.git] / readme.TXT
1 README
2 ======
3 The zendesk module allows you to integrate your drupal site with the zendesk 
4 customer support system (http://www.zendesk.com)
5
6 Zendesk allows external authentication. This means that your Drupal site can serve
7 as authentication service. This way customers have a seamless experience without 
8 having to log in in both the drupal site and the zendesk support system.
9
10 Installation is easy:
11 - install the module
12 - configure your zendesk account (go to 'Account - Security')
13   * Click "Enable Remote Authentication"
14   * insert the remote authentication url: http://yoursite.com/services/zendesk
15   * optionally you can insert your logout url: http://yoursite.com/logout    
16 - go to admin/settings/zendesk and fill in the url of your zendesk support page (e.g. http://yourdomain.zendesk.com) together with the secret key
17
18 Local Development
19 =================
20 Zendesk remote authentication does not require your site to be public.
21
22
23 Zendesk PHP library
24 ===================
25 This module depends on the Zendesk PHP library. For ease of use, this library is included with the module in the lib directory.
26 For more information on this library, please visit: http://code.google.com/p/zendesk-php-lib
27
28 =================
29 Originally developed for 6.x by twom <http://drupal.org/user/25564>
30 Ported to Drupal 7.x by markwk <http://drupal.org/user/1094790>