Skip to content

Commit 58d8c1d

Browse files
authored
Merge pull request #2 from jsirish/refactor/readMe
README initial
2 parents ca143f0 + 86a06f6 commit 58d8c1d

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
1-
# silverstripe-elemental-embedded-code
1+
# Silverstripe Elemental Embedded Code
22

33
A block to embed code like iFrames or Javascript on a page
44

5+
[![Build Status](https://travis-ci.org/dynamic/silverstripe-elemental-embedded-code.svg?branch=master)](https://travis-ci.org/dynamic/silverstripe-elemental-embedded-code)
6+
[![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)
7+
[![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)
8+
[![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)
9+
[![codecov](https://codecov.io/gh/dynamic/silverstripe-elemental-embedded-code/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-elemental-embedded-code)
10+
11+
[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/v/stable)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code)
12+
[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/downloads)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code)
13+
[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code)
14+
[![License](https://poser.pugx.org/dynamic/silverstripe-elemental-embedded-code/license)](https://packagist.org/packages/dynamic/silverstripe-elemental-embedded-code)
15+
516
## Requirements
617

7-
- SilverStripe 3.2
18+
* SilverStripe ^4.0
19+
* SilverStripe Elemental ^2.0
820

921
## Installation
1022

11-
This is how you install silverstripe-elemental-embedded-code.
23+
`composer require dynamic/silverstripe-elemental-embedded-code`
1224

1325
## Example usage
1426

15-
You use silverstripe-elemental-embedded-code like this.
27+
Adds a block to display embeddable code on a page. Useful for iFrames or Javascript embeds, like MailChimp sign up forms.
28+
29+
## Getting more elements
30+
31+
See [Elemental modules by Dynamic](https://github.com/dynamic/silverstripe-elemental-blocks#getting-more-elements)
1632

17-
## Documentation
33+
## Configuration
1834

19-
See the [docs/en](docs/en/index.md) folder.
35+
See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverstripe-elemental#configuration)

0 commit comments

Comments
 (0)