You are here

README.txt in Social Post 8.2

Same filename and directory in other branches
  1. 3.x README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

Social Post is part of the Social API. It provides a common interface for
creating modules related to autoposting to external provider services.

This module defines a path Administration » Configuration » Social API » Social
Post which displays a table of implementers (modules to autopost to external
providers on users' behalf).

This module does not restrict the way an implementer provides its functionality.
This allows the implementers to adapt to the external provider's requirements
they implement.

 * For a full description of the module, visit the project page:
  https://www.drupal.org/project/social_post

 * To submit bug reports and feature suggestions, or to track changes:
  https://www.drupal.org/project/issues/social_post


REQUIREMENTS
------------

This module requires the following module and library:

 * Required module: Social API (https://www.drupal.org/project/social_api)
 * Required library: The League OAuth2 client library


INSTALLATION
------------

 * To download the module with all dependencies run the below command:
  composer require drupal/social_post:^2.0

 * Install the module from admin module page (Administration » Extend) or using
  the drush command:
  drush en social_post


CONFIGURATION
-------------

 * Configure user permissions in Administration » People » Permissions:
  - Delete Social Post user accounts

    Users in roles with the "Delete Social Post user accounts" permission can
    delete all user accounts associated to all Drupal users.

  - Delete own Social Post user accounts

    Users in roles with the "Delete own Social Post user accounts" permission
    can delete own Social Post user accounts.

  - View Social Post user entity lists

    Users in roles with the "View Social Post user entity lists" permission can
    view Social Post user entity lists.

 * Go to Configuration » Social API settings » Autoposting settings.
  The list looks empty initially as you have not enabled an implementer yet.

 * To post to external providers, you need to install their respective Social
  Post implementers. After installing implementers, they will be displayed in
  the Social Post implementer list.

  Visit https://www.drupal.org/project/social_post to find all the available
  Social Post implementers.


MAINTAINERS
-----------

Current maintainers:
 * Getulio Valentin Sánchez (gvso) - https://www.drupal.org/u/gvso

This project has been supported by:
 * Google Summer of Code
  An annual program for university students organized by Google with projects
  managed by open source organization mentors such as us (Drupal!).
  Visit g.co/gsoc for more information.

 * Google Code-In
  The Google Code-In is a contest to introduce pre-university students (ages
  13-17) to the many kinds of contributions that make open source software
  development possible. Visit g.co/gci for more information.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. INTRODUCTION
  9. ------------
  10. Social Post is part of the Social API. It provides a common interface for
  11. creating modules related to autoposting to external provider services.
  12. This module defines a path Administration » Configuration » Social API » Social
  13. Post which displays a table of implementers (modules to autopost to external
  14. providers on users' behalf).
  15. This module does not restrict the way an implementer provides its functionality.
  16. This allows the implementers to adapt to the external provider's requirements
  17. they implement.
  18. * For a full description of the module, visit the project page:
  19. https://www.drupal.org/project/social_post
  20. * To submit bug reports and feature suggestions, or to track changes:
  21. https://www.drupal.org/project/issues/social_post
  22. REQUIREMENTS
  23. ------------
  24. This module requires the following module and library:
  25. * Required module: Social API (https://www.drupal.org/project/social_api)
  26. * Required library: The League OAuth2 client library
  27. INSTALLATION
  28. ------------
  29. * To download the module with all dependencies run the below command:
  30. composer require drupal/social_post:^2.0
  31. * Install the module from admin module page (Administration » Extend) or using
  32. the drush command:
  33. drush en social_post
  34. CONFIGURATION
  35. -------------
  36. * Configure user permissions in Administration » People » Permissions:
  37. - Delete Social Post user accounts
  38. Users in roles with the "Delete Social Post user accounts" permission can
  39. delete all user accounts associated to all Drupal users.
  40. - Delete own Social Post user accounts
  41. Users in roles with the "Delete own Social Post user accounts" permission
  42. can delete own Social Post user accounts.
  43. - View Social Post user entity lists
  44. Users in roles with the "View Social Post user entity lists" permission can
  45. view Social Post user entity lists.
  46. * Go to Configuration » Social API settings » Autoposting settings.
  47. The list looks empty initially as you have not enabled an implementer yet.
  48. * To post to external providers, you need to install their respective Social
  49. Post implementers. After installing implementers, they will be displayed in
  50. the Social Post implementer list.
  51. Visit https://www.drupal.org/project/social_post to find all the available
  52. Social Post implementers.
  53. MAINTAINERS
  54. -----------
  55. Current maintainers:
  56. * Getulio Valentin Sánchez (gvso) - https://www.drupal.org/u/gvso
  57. This project has been supported by:
  58. * Google Summer of Code
  59. An annual program for university students organized by Google with projects
  60. managed by open source organization mentors such as us (Drupal!).
  61. Visit g.co/gsoc for more information.
  62. * Google Code-In
  63. The Google Code-In is a contest to introduce pre-university students (ages
  64. 13-17) to the many kinds of contributions that make open source software
  65. development possible. Visit g.co/gci for more information.