Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions CONTRIBUTING.md

This file was deleted.

32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,21 @@ A block to embed code like iFrames or Javascript on a page

[![CI](https://github.com/dynamic/silverstripe-elemental-embedded-code/actions/workflows/ci.yml/badge.svg)](https://github.com/dynamic/silverstripe-elemental-embedded-code/actions/workflows/ci.yml) [![Sponsors](https://img.shields.io/badge/GitHub-Sponsors-ff69b4?logo=github)](https://github.com/sponsors/dynamic)


[![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/recipe-cms: ^6
* dnadesign/silverstripe-elemental: ^6
* silverstripe/framework: ^6
* silverstripe/vendor-plugin: ^3

## Installation

`composer require dynamic/silverstripe-elemental-embedded-code`

## License

See [License](LICENSE.md)

## Example usage

Adds a block to display embeddable code on a page. Useful for iFrames or Javascript embeds, like MailChimp sign up forms.
Expand All @@ -35,7 +31,6 @@ Adds a block to display embeddable code on a page. Useful for iFrames or Javascr
#### CMS - Embed Code Element Main Tab
![CMS - Embed Code Element Main Tab](./readme-images/embed-block-cms.jpg)


## Getting more elements

See [Elemental modules by Dynamic](https://github.com/orgs/dynamic/repositories?q=elemental&type=all&language=&sort=)
Expand All @@ -53,31 +48,28 @@ Dynamic\Elements\Embedded\Elements\ElementEmbeddedCode:
hide_content_field: true
```

See [SilverStripe Elemental Configuration](https://github.com/silverstripe/silverstripe-elemental#configuration)

## Translations

The translations for this project are managed via [Transifex](https://www.transifex.com/dynamicagency/silverstripe-elemental-baseobject/)
and are updated automatically during the release process. To contribute, please head to the link above and get
translating!
See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverstripe-elemental#configuration)

## Maintainers

* [Dynamic](https://www.dynamicagency.com) (<dev@dynamicagency.com>)

## Bugtracker
Bugs are tracked in the issues section of this repository. Before submitting an issue please read over
existing issues to ensure yours is unique.

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

- Create a new issue
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots
and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,
Operating System, any installed SilverStripe modules.
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

## Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

## License

See [License](LICENSE.md)
Loading