Updating Media dependent modules to versions compatible with core Media.
[yaffs-website] / web / modules / contrib / media_entity_instagram / README.md
index 18b114e05d7ebdf2832c05bdf14ec07cb8afd541..d2a06e41092b271757d1cfef3d27d1b0e351ee02 100644 (file)
@@ -1,50 +1,23 @@
-## About Media entity
-
-Media entity provides a 'base' entity for a media element. This is a very basic
-entity which can reference to all kinds of media-objects (local files, YouTube
-videos, tweets, CDN-files, ...). This entity only provides a relation between
-Drupal (because it is an entity) and the resource. You can reference to this
-entity within any other Drupal entity.
-
 ## About Media entity Instagram
 
-This module provides Instagram integration for Media entity (i.e. media type provider
+This module provides Instagram integration for Media (i.e. media type provider
 plugin).
 
 ### Instagram API
-This module uses Instagrams oembed API to fetch the instagram html and all the metadata.
-You will need to:
-
-- Create a Media bundle with the type provider "Instagram".
-- On that bundle create a field for the Instagram url/source (this should be a plain text or link field).
-- Return to the bundle configuration and set "Field with source information" to use that field.
-
-### Storing field values
-If you want to store the fields that are retrieved from Instagram you should create appropriate fields on the created media bundle (id) and map this to the fields provided by Instagram.php.
-
-**NOTE:** At the moment there is no GUI for that, so the only method of doing that for now is via CMI.
-
-This would be an example of that (the field_map section):
-
-```
-langcode: en
-status: true
-dependencies:
-  module:
-    - media_entity_instagram
-id: instagram
-label: Instagram
-description: 'Instagram photo/video to be used with content.'
-type: instagram
-type_configuration:
-  source_field: link
-field_map:
-  id: instagram_id
-  type: instagram_type
-  thumbnail: instagram_thumbnail
-  username: instagram_username
-  caption: instagram_caption
-```
+This module uses Instagrams oembed API to fetch the instagram html and all the
+metadata.
+
+After enabling the module, you can create a new Media Type choosing "Instagram"
+on the provider dropdown.
+
+A source field will be automatically created and configured on the Media Type if
+this is the first Instagram type on the site. If you need to have additional
+types, you can choose to reuse an existing field as source, or create one field
+per type. Source fields for the Instagram Media Type need to be plain text or
+link fields.
+
+Please refer to the Media documentation for more instructions on how to work
+with Media Types.
 
 Project page: http://drupal.org/project/media_entity_instagram