2013-02-27 05:09:14 +01:00
# IFrame module
2017-11-22 22:47:30 +01:00
[![Build Status ](https://travis-ci.org/silverstripe/silverstripe-iframe.svg?branch=master )](https://travis-ci.org/silverstripe/silverstripe-iframe)
[![Scrutinizer Code Quality ](https://scrutinizer-ci.com/g/silverstripe/silverstripe-iframe/badges/quality-score.png?b=master )](https://scrutinizer-ci.com/g/silverstripe/silverstripe-iframe/?branch=master)
[![codecov ](https://codecov.io/gh/silverstripe/silverstripe-iframe/branch/master/graph/badge.svg )](https://codecov.io/gh/silverstripe/silverstripe-iframe)
2018-06-15 07:42:41 +02:00
[![SilverStripe supported module ](https://img.shields.io/badge/silverstripe-supported-0071C4.svg )](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
2017-11-22 22:47:30 +01:00
[![Version ](http://img.shields.io/packagist/v/silverstripe/iframe.svg?style=flat )](https://packagist.org/packages/silverstripe/silverstripe-iframe)
[![License ](http://img.shields.io/packagist/l/silverstripe/iframe.svg?style=flat )](LICENSE.md)
2013-02-27 05:09:14 +01:00
## Introduction
The iframe module provides an IFrame page type that allows you to embed an IFrame into a page without resorting to
custom code.
## Requirements
2017-11-22 22:47:30 +01:00
* SilverStripe ^4.0
**Note:** For a SilverStripe 3.x compatible version, please use [the 1.x release line ](https://github.com/silverstripe/silverstripe-iframe/tree/1.0 ).
2013-02-27 05:09:14 +01:00
## Installation
2017-11-22 22:47:30 +01:00
Run `composer require silverstripe/iframe` , then append dev/build?flush=all to the website URL in your
browser. e.g. http://mysite.test/dev/build?flush=all
2013-02-27 05:09:14 +01:00
## Instructions
2017-11-22 22:47:30 +01:00
For usage instructions see the [user manual ](docs/en/userguide/index.md ).
2013-10-24 22:21:58 +02:00
## Contributing
### Translations
Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.
2016-02-24 15:03:05 +01:00
Please use [https://www.transifex.com/projects/p/silverstripe-iframe ](https://www.transifex.com/projects/p/silverstripe-iframe ) to contribute translations, rather than sending pull requests with YAML files.