diff --git a/README.md b/README.md index 72e7820..44665ea 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ -# silverstripe-elemental-embedded-code +# Silverstripe Elemental Embedded Code A block to embed code like iFrames or Javascript on a page +[![Build Status](https://travis-ci.org/dynamic/silverstripe-elemental-embedded-code.svg?branch=master)](https://travis-ci.org/dynamic/silverstripe-elemental-embedded-code) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/?branch=master) +[![Code Coverage](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/?branch=master) +[![Build Status](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/badges/build.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-embedded-code/build-status/master) +[![codecov](https://codecov.io/gh/dynamic/silverstripe-elemental-embedded-code/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-elemental-embedded-code) + +[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/v/stable)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code) +[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/downloads)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code) +[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code) +[![License](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/license)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code) + ## Requirements -- SilverStripe 3.2 +* SilverStripe ^4.0 +* SilverStripe Elemental ^2.0 ## Installation -This is how you install silverstripe-elemental-embedded-code. +`composer require dynamic/silverstripe-elemental-embedded-code` ## Example usage -You use silverstripe-elemental-embedded-code like this. +Adds a block to display embeddable code on a page. Useful for iFrames or Javascript embeds, like MailChimp sign up forms. + +## Getting more elements + +See [Elemental modules by Dynamic](https://github.com/dynamic/silverstripe-elemental-blocks#getting-more-elements) -## Documentation +## Configuration -See the [docs/en](docs/en/index.md) folder. +See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverstripe-elemental#configuration)