Skip to content
Snippets Groups Projects
Commit 1ecf3f9f authored by Charchil Khandelwal's avatar Charchil Khandelwal Committed by Nicolas N
Browse files

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

parent c10c72f3
No related branches found
No related tags found
1 merge request!8Issue #3338121: Update README.md file according to "README.md template"
CONTENTS OF THIS FILE
---------------------
# Social networks wall
* Introduction
* Installation
* Requirements
* Configuration
* Examples
* Maintainers
This module provides a block with a list containing data from social networks.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/social_wall).
INTRODUCTION
------------
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/social_wall).
This module provides a block with a list containing data from social networks.
## Contents of this file
- Installation
- Requirements
- Configuration
- Examples
- Maintainers
INSTALLATION
------------
* Install the Social Networks Wall module as you would normally install a
contributed Drupal module.
Visit https://www.drupal.org/node/1897420 for further information.
## 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).
REQUIREMENTS
------------
## Requirements
This module requires 2 external libraries (for Twitter & Instagram plugins),
that are automatically installed when requiring the module :
* `"abraham/twitteroauth": "^2"`
* `"pgrimaud/instagram-user-feed": "^6"`
- `"abraham/twitteroauth": "^2"`
- `"pgrimaud/instagram-user-feed": "^6"`
CONFIGURATION
-------------
## Configuration
1. Create new social network (optional, for a specific need) :
* Create a new plugin in `[your_module_name]/src/Plugin/SocialNetwork` that
- Create a new plugin in `[your_module_name]/src/Plugin/SocialNetwork` that
extends `SocialNetworkBase`
* Implement at least these functions:
* `getLabel()` : returns the label of the social network
* `settingsForm(array $settings = [])`: returns the configuration form
of this
social network
* `render()`: returns the social network render array
* Clear your cache ;)
- Implement at least these functions:
- `getLabel()` : returns the label of the social network
- `settingsForm(array $settings = [])`: returns the configuration form
of this social network
- `render()`: returns the social network render array
- Clear your cache ;)
2. Configure social networks:
* Go to `admin/config/services/social-wall`
(or Configuration > Web services > Social networks) to configure
existing social networks.
- Go to `admin/config/services/social-wall` (or Configuration > Web
services > Social networks) to configure existing social networks.
3. Display social wall block:
Chose which social networks to display, and the order, in block
configuration.
......@@ -58,20 +57,20 @@ CONFIGURATION
in your theme.
EXAMPLES
--------
## Examples
This module contains 2 basic plugin examples in
`social_wall/src/Plugin/SocialNetwork`:
* Twitter
* Instagram
- Twitter
- Instagram
MAINTAINERS
-----------
## Maintainers
* Nicolas Nucci (NicociN) - https://www.drupal.org/u/nicocin
- Nicolas N - [NicociN](https://www.drupal.org/u/nicocin)
- Marc-Antoine Marty - [Martygraphie](https://www.drupal.org/u/martygraphie)
- sbruyas - [sbruyas](https://www.drupal.org/u/sbruyas)
Supporting organizations:
* Ecedi - https://www.drupal.org/ecedi
- Ecedi - [Ecedi](https://www.drupal.org/ecedi)
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