You are here

Home » API reference » Shariff Social Media Buttons 7

README.txt in Shariff Social Media Buttons 7

Same filename and directory in other branches
  1. 8 README.txt
                                   ()
  ┌───────┐                        /\
  │       │                   ()--'  '--()
  │  a:o  │  acolono.com        `.    .'       Shariff Module
  │       │                      / .. \
  └───────┘                     ()'  '()


This module implements the Shariff sharing buttons by heise online:
https://github.com/heiseonline/shariff

Shariff enables website users to share their favorite content without
compromising their privacy.

It consists of two parts: a simple JavaScript client library and an
optional server-side component. The latter fetches the number of likes,
tweets and plus-ones.

The base shariff Drupal module implements the JavaScript library to
display the buttons as a block and a panels pane.


-- REQUIREMENTS --

* Libraries API module
  http://drupal.org/project/libraries
  
* Shariff Library (at least v1.4.6)
  https://github.com/heiseonline/shariff

* JQuery Update module
  http://drupal.org/project/jquery_update
  Shariff requires jQuery 1.7 or higher. Please configure jQuery Update
  accordingly.


-- INSTALLATION --

1) Download the library from https://github.com/heiseonline/shariff and place
it in your libraries folder.
When your libraries folder is "sites/all/libraries" the JavaScript and the
CSS files should be available under
"sites/all/libraries/shariff/build/shariff.min.js",
"sites/all/libraries/shariff/build/shariff.min.css" and
"sites/all/libraries/shariff/build/shariff.complete.css".
You only need the build folder and at least v1.4.6 of the library.

When you have drush you can use "drush shariff-library" or "drush shariff"
to download the library into your "sites/all/libraries" folder. If needed
specify another libraries path as argument:
E.g. "drush shariff sites/default/libraries"


2) Activate the module.

3) Set your default settings under /admin/config/services/shariff. When you
have Font Awesome already loaded on your site be sure to choose the Minimal
CSS option (so that shariff.min.css without Font Awesome will be loaded).

4) Now you can place the buttons as a block, a field or as a panels pane.
You find the panels pane in the panels content administration UI
under Widgets.

File

README.txt
View source 
  1. 

  2.                                    ()

  3.   ┌───────┐                        /\

  4.   │       │                   ()--'  '--()

  5.   │  a:o  │  acolono.com        `.    .'       Shariff Module

  6.   │       │                      / .. \

  7.   └───────┘                     ()'  '()

  8. 

  9. 

  10. This module implements the Shariff sharing buttons by heise online:

  11. https://github.com/heiseonline/shariff

  12. 

  13. Shariff enables website users to share their favorite content without

  14. compromising their privacy.

  15. 

  16. It consists of two parts: a simple JavaScript client library and an

  17. optional server-side component. The latter fetches the number of likes,

  18. tweets and plus-ones.

  19. 

  20. The base shariff Drupal module implements the JavaScript library to

  21. display the buttons as a block and a panels pane.

  22. 

  23. 

  24. -- REQUIREMENTS --

  25. 

  26. * Libraries API module

  27.   http://drupal.org/project/libraries

  28.   

  29. * Shariff Library (at least v1.4.6)

  30.   https://github.com/heiseonline/shariff

  31. 

  32. * JQuery Update module

  33.   http://drupal.org/project/jquery_update

  34.   Shariff requires jQuery 1.7 or higher. Please configure jQuery Update

  35.   accordingly.

  36. 

  37. 

  38. -- INSTALLATION --

  39. 

  40. 1) Download the library from https://github.com/heiseonline/shariff and place

  41. it in your libraries folder.

  42. When your libraries folder is "sites/all/libraries" the JavaScript and the

  43. CSS files should be available under

  44. "sites/all/libraries/shariff/build/shariff.min.js",

  45. "sites/all/libraries/shariff/build/shariff.min.css" and

  46. "sites/all/libraries/shariff/build/shariff.complete.css".

  47. You only need the build folder and at least v1.4.6 of the library.

  48. 

  49. When you have drush you can use "drush shariff-library" or "drush shariff"

  50. to download the library into your "sites/all/libraries" folder. If needed

  51. specify another libraries path as argument:

  52. E.g. "drush shariff sites/default/libraries"

  53. 

  54. 

  55. 2) Activate the module.

  56. 

  57. 3) Set your default settings under /admin/config/services/shariff. When you

  58. have Font Awesome already loaded on your site be sure to choose the Minimal

  59. CSS option (so that shariff.min.css without Font Awesome will be loaded).

  60. 

  61. 4) Now you can place the buttons as a block, a field or as a panels pane.

  62. You find the panels pane in the panels content administration UI

  63. under Widgets.