www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/media_entity/README.md

   1 ## About Media entity
   2
   3 [![Travis](https://img.shields.io/travis/drupal-media/media_entity.svg)]() [![Scrutinizer](https://img.shields.io/scrutinizer/g/drupal-media/media_entity.svg)]()
   4
   5 Media entity provides a 'base' entity for media. This is a very basic entity
   6 which can reference to all kinds of media-objects (local files, YouTube
   7 videos, Tweets, Instagram photos, ...). Media entity provides a relation between
   8 Drupal and the media resource. You can reference to/use this entity within any
   9 other Drupal entity.
  10
  11 This module attempts to provide the base storage component for the Drupal 8
  12 media ecosystem.
  13
  14 Project page: https://drupal.org/project/media_entity
  15
  16 ## Official documentation
  17
  18 You will find all the documentation about this module on the [official handbook](https://drupal-media.gitbooks.io/drupal8-guide/content/modules/media_entity/intro.html).
  19
  20 ## Contribute
  21
  22 Our current development focus can be seen in [the roadmap issue](https://www.drupal.org/node/2577453).
  23
  24 Development is generally done via [GitHub pull requests](https://github.com/drupal-media/media_entity/pulls).
  25 Every pull request should be linked to an [issue in drupal.org issue queue](http://drupal.org/project/issues/media_entity)
  26 and vice-versa.
  27
  28 If you prefer usual patch-based workflow feel free to submit a patch. We started
  29 using GitHub mostly for easier review process. However, there are not strong opinions
  30 about that. Any contribution in any shape or form will be treated equally.
  31
  32 ## Media provider modules
  33
  34 There are already several media provider modules that extend functionality of
  35 Media entity:
  36
  37 - [Image](https://drupal.org/project/media_entity_image)
  38 - [Audio](https://drupal.org/project/media_entity_audio)
  39 - [Slideshow](https://drupal.org/project/media_entity_slideshow)
  40 - [Video embed field](https://drupal.org/project/video_embed_field)
  41 - [Twitter](https://drupal.org/project/media_entity_twitter)
  42 - [Instagram](https://drupal.org/project/media_entity_instagram)
  43 - [Document](https://drupal.org/project/media_entity_document)
  44 - [Slideshare](https://drupal.org/project/media_entity_slideshare)
  45 - [Video (local)](https://drupal.org/project/media_entity_video)
  46 - [Tumblr](https://drupal.org/project/media_entity_tumblr)
  47 - [Facebook](https://drupal.org/project/media_entity_facebook)
  48 - [Audio embed field (sandbox)](https://drupal.org/sandbox/vilepickle/2784301)
  49
  50 ## Other modules that integrate with media entity
  51
  52 - [Entity browser](https://drupal.org/project/entity_browser): Provides entity browser
  53   widget that supports uploading [Media entity images](https://drupal.org/project/media_entity_image).
  54 - [DropzoneJS](https://drupal.org/project/dropzonejs): Extends entity browser [image
  55   upload widget](https://drupal.org/project/media_entity_image) with [DropzoneJS
  56   upload library](http://www.dropzonejs.com).
  57 - [Slick media](https://drupal.org/project/slick_media): Provides integration
  58 between [Slick carousel](https://drupal.org/project/slick) and Media entity. Slick media allows richer slideshows/carousel
  59   with a mix of text, image and video.
  60 - [Brightcove](https://github.com/dawehner/media_entity_brightcove)
  61
  62 ## Maintainers
  63 - Janez Urevc ([@slashrsm](https://github.com/slashrsm)) https://drupal.org/user/744628
  64 - Primož Hmeljak ([@primsi](https://github.com/primsi)) https://drupal.org/user/282629
  65 - Nguyễn Hải Nam (@jcisio) https://drupal.org/user/210762
  66 - Boris Gordon (@boztek) https://drupal.org/user/134410
  67
  68 ## Get in touch
  69 - http://groups.drupal.org/media
  70 - IRC: #drupal-media @ Freenode