You are here

README.txt in Simple Instagram Feed Block 8.3

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 7 README.txt
  4. 1.0.x README.txt
INTRODUCTION
------------
Simple Instagram Feed is an integration module for the jquery.instagramFeed
library that can be found at https://github.com/jsanahuja/jquery.instagramFeed.

BENEFITS
--------
Unlike many Instagram integrations, this module does not require a complicated
token and authorization sequence to use. Simply add the jquery.instagramFeed
library, install this module and place the block, assign the Instagram account
that you would like to pull the feed from and save. If you want to change the
number of images or any other settings, use the block settings.


REQUIREMENTS
------------
This module requires the jquery.instagramFeed library that can be found at
https://github.com/jsanahuja/jquery.instagramFeed.

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

* Without Composer *
Download the repository for the jquery.instagramFeed library that can be found
at https://github.com/jsanahuja/jquery.instagramFeed .

Place the file jquery.instagramFeed.min.js in a directory called:
jqueryinstagramfeed

Install the Simple Instagram Feed Block:
  Using DRUSH: drush en simple_instagram_feed
  -or-
  Download it from https://www.drupal.org/project/simple_instagram_feed and i
  nstall it to your website.

* With Composer *

To install this module and the jquery.instagramFeed library with composer,
You will need to perform the following four (4) steps:

1) Edit composer.json to include the jquery.instagramFeed repository.
2) Install the jquery.instagramFeed Library.
3) Install the Simple Instagram Feed module.
4) Enable the Simple Instagram Feed module.

1) Add the code below to into your project's composer.json,
under "repositories":

"repositories": [
  {
    "type": "package",
    "package": {
      "name": "jsanahuja/jqueryinstagramfeed",
      "version": "dev-master",
      "type": "drupal-library",
      "dist": {
        "url": "https://github.com/jsanahuja/jquery.instagramFeed/archive/master.zip",
        "type": "zip"
      }
    }
  }
]

If the installer path is not set, use:

"extra": {
    "installer-paths": {
        "web/libraries/{$name}": ["type:drupal-library"]
    }
}

2) Install the jquery.instagramFeed Library, run:
  $ composer require jsanahuja/jqueryinstagramfeed:dev-master

3) Install the Simple Instagram Feed module, run:
  $ composer require 'drupal/simple_instagram_feed

4) Within the Administration menu in your website, navigate to Extend and
enable the Simple Instagram Feed module.


CONFIGURATION
-------------
Once you have installed Simple Instagram Feed Block and placed the
jquery.inatagramFeed library in your libraries directory, navigate to
Structure -> Block Layout (/admin/structure/block) to create a new Simple
Instagram Feed block on your site. By default the block will use the Instagram
account and display 12 images, 6 images per row. You can change the Instagram
user account, number of images and number of images per row settings as well as
displaying the Profile and Bio for the Instagram account.

KNOWN LIMITATIONS
-----------------
If you would like to have different feeds on different pages, you can create as
many feed blocks as you like. However you can not have more than one feed per
page. This is being worked on and will hopefully be resolved for a future
release.

File

README.txt
View source
  1. INTRODUCTION
  2. ------------
  3. Simple Instagram Feed is an integration module for the jquery.instagramFeed
  4. library that can be found at https://github.com/jsanahuja/jquery.instagramFeed.
  5. BENEFITS
  6. --------
  7. Unlike many Instagram integrations, this module does not require a complicated
  8. token and authorization sequence to use. Simply add the jquery.instagramFeed
  9. library, install this module and place the block, assign the Instagram account
  10. that you would like to pull the feed from and save. If you want to change the
  11. number of images or any other settings, use the block settings.
  12. REQUIREMENTS
  13. ------------
  14. This module requires the jquery.instagramFeed library that can be found at
  15. https://github.com/jsanahuja/jquery.instagramFeed.
  16. INSTALLATION
  17. ------------
  18. * Without Composer *
  19. Download the repository for the jquery.instagramFeed library that can be found
  20. at https://github.com/jsanahuja/jquery.instagramFeed .
  21. Place the file jquery.instagramFeed.min.js in a directory called:
  22. jqueryinstagramfeed
  23. Install the Simple Instagram Feed Block:
  24. Using DRUSH: drush en simple_instagram_feed
  25. -or-
  26. Download it from https://www.drupal.org/project/simple_instagram_feed and i
  27. nstall it to your website.
  28. * With Composer *
  29. To install this module and the jquery.instagramFeed library with composer,
  30. You will need to perform the following four (4) steps:
  31. 1) Edit composer.json to include the jquery.instagramFeed repository.
  32. 2) Install the jquery.instagramFeed Library.
  33. 3) Install the Simple Instagram Feed module.
  34. 4) Enable the Simple Instagram Feed module.
  35. 1) Add the code below to into your project's composer.json,
  36. under "repositories":
  37. "repositories": [
  38. {
  39. "type": "package",
  40. "package": {
  41. "name": "jsanahuja/jqueryinstagramfeed",
  42. "version": "dev-master",
  43. "type": "drupal-library",
  44. "dist": {
  45. "url": "https://github.com/jsanahuja/jquery.instagramFeed/archive/master.zip",
  46. "type": "zip"
  47. }
  48. }
  49. }
  50. ]
  51. If the installer path is not set, use:
  52. "extra": {
  53. "installer-paths": {
  54. "web/libraries/{$name}": ["type:drupal-library"]
  55. }
  56. }
  57. 2) Install the jquery.instagramFeed Library, run:
  58. $ composer require jsanahuja/jqueryinstagramfeed:dev-master
  59. 3) Install the Simple Instagram Feed module, run:
  60. $ composer require 'drupal/simple_instagram_feed
  61. 4) Within the Administration menu in your website, navigate to Extend and
  62. enable the Simple Instagram Feed module.
  63. CONFIGURATION
  64. -------------
  65. Once you have installed Simple Instagram Feed Block and placed the
  66. jquery.inatagramFeed library in your libraries directory, navigate to
  67. Structure -> Block Layout (/admin/structure/block) to create a new Simple
  68. Instagram Feed block on your site. By default the block will use the Instagram
  69. account and display 12 images, 6 images per row. You can change the Instagram
  70. user account, number of images and number of images per row settings as well as
  71. displaying the Profile and Bio for the Instagram account.
  72. KNOWN LIMITATIONS
  73. -----------------
  74. If you would like to have different feeds on different pages, you can create as
  75. many feed blocks as you like. However you can not have more than one feed per
  76. page. This is being worked on and will hopefully be resolved for a future
  77. release.