Skip to content

Commit

Permalink
compatibility note to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sheadawson committed Nov 9, 2016
1 parent a32a84c commit 1438234
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
Provides a GUI for CMS users to insert Shortcodes into the HTMLEditorField + an API for developers to define Shortcodable DataObjects and Views. This allows CMS users to easily embed and customise DataObjects and templated HTML snippets anywhere amongst their page content. Shortcodes can optionally be represented in the WYSIWYG with a custom placeholder image.

## Requirements
* SilverStripe 3.1 +
* SilverStripe 3.5 +

See 2.x branch/releases for SilverStripe 3.1 - 3.4 compatibility

## Installation
Install via composer, run dev/build
Expand Down Expand Up @@ -38,4 +40,3 @@ Double clicking a shortcode placeholder in the editor will also open the popup t
## Upgrading from 1.x
Shortcodable 2.0 has an improved method for applying Shortcodable to DataObjects. We no longer use an interface, as this didn't allow for Shortcodable to be applied to core classes such as File, Member, Page etc without changing core code. Instead, Shortcodable is applied to your Objects via yml config. Some methods have also changed from statics to normal methods. See updated examples below.

0 comments on commit 1438234

Please sign in to comment.