Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update README.md

  • Loading branch information...
commit 656fb5f037d755b3b5e36bb7a73c9abe506495ec 1 parent 979dadf
Kim Ausloos kimausloos authored

Showing 1 changed file with 6 additions and 76 deletions. Show diff stats Hide diff stats

  1. +6 76 README.md
82 README.md
Source Rendered
... ... @@ -1,80 +1,10 @@
1   -KunstmaanMediaBundle
2   -====================
  1 +# KunstmaanMediaBundle [![Build Status](https://travis-ci.org/Kunstmaan/KunstmaanMediaBundle.png?branch=master)](http://travis-ci.org/Kunstmaan/KunstmaanMediaBundle)
3 2
4   -While building websites for clients we have learned that almost every website benefits from a centralised management of multimedia assets. To facilitate our building process we have created this bundle to add this functionality with the least amount of hassle. Additionally, we want our websites to leverage external services as much as possible, so all video and presentation content is offloaded (manually) to external website.
  3 +To build your perfect website you probably need images, video's or maybe even a presentation too. The Kunstmaan Media Bundle handles all those media assets and centralizes them so you can find your content just the way you like it: fast and efficiently. No central asset management module is useful without some pretty advanced image editing functionality. To provide this we have integrated the Aviary image editing service right from the interface.
5 4
6   -This bundle provides this centralised module for multimedia assets, and has built in providers for local images, [YouTube](http://www.youtube.com), [Vimeo](http://www.vimeo.com) and [Dailymotion](http://www.Dailymotion.com) video's, [Slideshare](http://www.slideshare.net/) presentations, and generic local files.
  5 +[![KunstmaanMediaBundle](http://bundles.kunstmaan.be/bundles/kunstmaankunstmaanbundles/img/features/media.png)](http://bundles.kunstmaan.be)
  6 +View more screenshots and information [http://bundles.kunstmaan.be](http://bundles.kunstmaan.be).
7 7
8   -No central asset management module is useful without some pretty advanced image editing functionality. To provide this we have integrated the [Aviary](http://www.aviary.com/) image editing service right from the interface. This provides us with all the tools needed to manage images in a website, without the need of a Photoshop or other image editing tool on the administrators computer.
  8 +## Installation
9 9
10   -View some screenshots on this bundles [github page](http://kunstmaan.github.com/KunstmaanMediaBundle).
11   -
12   -> ** Important Note **
13   ->
14   -> Once again, we're not reinventing code here, the code in this bundle is heavily inspired from the [AnoMediaBundle](https://github.com/benjamindulau/AnoMediaBundle)
15   -> which on his turn is based on the [SonataMediaBundle](https://github.com/sonata-project/SonataMediaBundle).
16   ->
17   -> The KunstmaanMediaBundle is different in the way that it's base handles galleries, videos and slides without the hassle of adding them yourself.
18   ->
19   -> We didn't chose to fork the AnoMediaBundle but started the KunstmaanMediaBundle from scratch. This way we could find out the inner workings of the AnoMediaBundle more easily.
20   -> But keep in mind the code in the AnoMediaBundle is reused at a lot of places.
21   -
22   -Licensing
23   ----------
24   -
25   -The KunstmaanMediaBundle is licensed under the MIT License.
26   -
27   - The MIT License (MIT)
28   - Copyright (c) 2012 Kunstmaan NV
29   -
30   - Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
31   - documentation files (the "Software"), to deal in the Software without restriction, including without limitation
32   - the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
33   - and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
34   -
35   - The above copyright notice and this permission notice shall be included in all copies or substantial portions
36   - of the Software.
37   -
38   - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
39   - TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
40   - THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
41   - CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
42   - IN THE SOFTWARE.
43   -
44   -
45   -Installation requirements
46   --------------------------
47   -
48   -The KunstmaanMediaBundle depends on the hard work of the PHP and Symfony community and uses the following bundles. Please refer to their documentation for installation and configuration instructions.
49   -
50   -* [Imagine](https://github.com/avalanche123/Imagine)
51   -* [AvalancheImagineBundle](https://github.com/avalanche123/AvalancheImagineBundle)
52   -* [Gaufrette](https://github.com/KnpLabs/Gaufrette)
53   -
54   -Installation instructions
55   --------------------------
56   -Assuming you have installed composer.phar or composer binary:
57   -
58   -``` bash
59   -$ composer require kunstmaan/media-bundle
60   -```
61   -
62   -Add the KunstmaanMediaBundle to your AppKernel.php file:
63   -
64   -```
65   -new Kunstmaan\MediaBundle\KunstmaanMediaBundle(),
66   -```
67   -
68   -Known issues
69   -------------
70   -
71   -This is the first public alpha release of this bundle. Sensible unit tests are still missing, and the coupling with our other bundles is still too tight. Expect these issues to be solved by version v0.2
72   -
73   -Continuous testing on Travis CI is implemented: [![Build Status](https://secure.travis-ci.org/Kunstmaan/KunstmaanMediaBundle.png?branch=master)](http://travis-ci.org/Kunstmaan/KunstmaanMediaBundle)
74   -
75   -Reporting an issue or a feature request
76   ----------------------------------------
77   -
78   -Issues and feature requests are tracked in the [Github issue tracker](https://github.com/Kunstmaan/KunstmaanMediaBundle/issues).
79   -
80   -When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps.
  10 +This bundle is compatible with all Symfony 2.1.* releases. More information about installing can be found in this line by line walkthrough of installing Symfony and all our bundles, please refer to the [Getting Started guide](http://bundles.kunstmaan.be/doc/01_GettingStarted.html) and enjoy the full blown experience.

0 comments on commit 656fb5f

Please sign in to comment.
Something went wrong with that request. Please try again.