# README

[![Build Status](https://travis-ci.org/egeloen/IvoryCKEditorBundle.svg?branch=master)](http://travis-ci.org/egeloen/IvoryCKEditorBundle)
[![Coverage Status](https://coveralls.io/repos/egeloen/IvoryCKEditorBundle/badge.png?branch=master)](https://coveralls.io/r/egeloen/IvoryCKEditorBundle?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/egeloen/IvoryCKEditorBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/egeloen/IvoryCKEditorBundle/?branch=master)
[![Dependency Status](http://www.versioneye.com/php/egeloen:ckeditor-bundle/badge.svg)](http://www.versioneye.com/php/egeloen:ckeditor-bundle)

[![Latest Stable Version](https://poser.pugx.org/egeloen/ckeditor-bundle/v/stable.svg)](https://packagist.org/packages/egeloen/ckeditor-bundle)
[![Latest Unstable Version](https://poser.pugx.org/egeloen/ckeditor-bundle/v/unstable.svg)](https://packagist.org/packages/egeloen/ckeditor-bundle)
[![Total Downloads](https://poser.pugx.org/egeloen/ckeditor-bundle/downloads.svg)](https://packagist.org/packages/egeloen/ckeditor-bundle)
[![License](https://poser.pugx.org/egeloen/ckeditor-bundle/license.svg)](https://packagist.org/packages/egeloen/ckeditor-bundle)

The bundle provides a [CKEditor](http://ckeditor.com/) integration for your Symfony2 Project. It automatically registers
the new `ckeditor` form type which can be easily configured.

## Documentation

 1. [Installation](/Resources/doc/installation.md)
 2. [Usage](/Resources/doc/usage.md)
 3. [Configuration](/Resources/doc/configuration.md) (Optional)
 4. [File Browse/Upload](/Resources/doc/file_browse_upload.md) (Optional)

## Testing

The bundle is fully unit tested by [PHPUnit](http://www.phpunit.de/) with a code coverage close to **100%**. To
execute the test suite, check the travis [configuration](/.travis.yml).

## Contribute

We love contributors! Ivory is an open source project. If you'd like to contribute, feel free to propose a PR!.

## License

The Ivory CKEditor Bundle is under the MIT license. For the full copyright and license information, please read the
[LICENSE](/LICENSE) file that was distributed with this source code.
