mirror of
https://github.com/silverstripe/silverstripe-iframe
synced 2024-10-22 11:05:51 +02:00
35 lines
1.8 KiB
Markdown
35 lines
1.8 KiB
Markdown
# IFrame module
|
|
[](https://travis-ci.org/silverstripe/silverstripe-iframe)
|
|
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-iframe/?branch=master)
|
|
[](https://codecov.io/gh/silverstripe/silverstripe-iframe)
|
|
[](https://packagist.org/packages/silverstripe/silverstripe-iframe)
|
|
[](LICENSE.md)
|
|
|
|
## 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
|
|
|
|
* 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).
|
|
|
|
## Installation
|
|
|
|
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
|
|
|
|
## Instructions
|
|
|
|
For usage instructions see the [user manual](docs/en/userguide/index.md).
|
|
|
|
## 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.
|
|
|
|
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.
|