Skip to content
Snippets Groups Projects
Commit 789f9be9 authored by jay jangid's avatar jay jangid Committed by jay jangid
Browse files

Issue #3337499: Update README.md file according to "README.md template"

parent 119a87ea
No related branches found
No related tags found
1 merge request!1Issue #3337499: Update README.md file according to "README.md template"
CONTENTS OF THIS FILE
---------------------
# Pusher API
* Introduction
* Requirements
* Installation
* Configuration
* Maintainers
This module connects Drupal and [Pusher](https://pusher.com/) to add
realtime data.
INTRODUCTION
------------
For now this module adds the option to trigger events in Pusher on
node events. Think of node creation, updating and deleting.
The Pusher API module provides a connection between Drupal and the Pusher API
(www.pusher.com).
For a full description of the module, visit the
[project page](https://www.drupal.org/project/pusher_api).
* For a full description of the module, visit the project page:
https://www.drupal.org/project/pusher_api
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/pusher_api).
* To submit bug reports and feature suggestions, or track changes:
https://www.drupal.org/project/issues/pusher_api
REQUIREMENTS
------------
## Table of contents
- Requirements
- Installation
- Configuration
- Maintainers
## Requirements
This module requires no modules outside of Drupal core.
INSTALLATION
------------
## Installation
Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
* Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/node/1897420 for further information.
CONFIGURATION
-------------
## Configuration
1. Go to www.pusher.com and create a new app.
2. Find you app keys and add them to the settings.php
......@@ -44,24 +45,23 @@ CONFIGURATION
$settings['pusher_api']['api_settings']['cluster'] = 'cluster';
```
3. Navigate to Administration > Extend and enable the module.
4. Navigate to Administration > Configuration > Webservices > Pusher API for configurations. Save Configurations.
4. Navigate to Administration > Configuration > Webservices >
Pusher API for configurations. Save Configurations.
Configurable parameters:
**Configurable parameters:**
* Default channel name
* Send triggers to Pusher for node events (creation, updating and deleting of nodes)
- Default channel name
- Send triggers to Pusher for node events (creation, updating and deleting of nodes)
HOOKS
-----
**Hooks**
This modules implements some custom hooks. You can find them in pusher_api.api.php
MAINTAINERS
-----------
## Maintainers
* Fabian de Rijk - https://www.drupal.org/u/fabianderijk
- Fabian de Rijk - [fabianderijk](https://www.drupal.org/u/fabianderijk)
Supporting organization:
**Supporting organization:**
* Finalist - https://www.drupal.org/finalist
\ No newline at end of file
- [Finalist](https://www.drupal.org/finalist)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment