Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
boye committed Aug 15, 2013
1 parent fe283c7 commit a22f581
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Expand Up @@ -8,9 +8,18 @@ All I did was wrap both libraries up in a TinyMCE plugin ;-)

A demo is located at: <a href="http://github.e-sites.nl/tinymce-emmet-plugin/">http://github.e-sites.nl/tinymce-emmet-plugin/</a>

<em>Please note that this plugin is still work in progress.</em>

##Getting started
Create an 'emmet' directory in the plugin file structure and copy/paste at least the following directories and files:

```
/tinymce/plugins/emmet/css
/tinymce/plugins/emmet/js
/tinymce/plugins/emmet/editor.html
/tinymce/plugins/emmet/plugin.js
/tinymce/plugins/emmet/plugin.min.js
```

Pass along the name of the plugin to the <code>plugins</code> property of the <code>init</code> method and you're good to go.
```js
tinymce.init({
selector: '#editor',
Expand All @@ -20,9 +29,16 @@ tinymce.init({
});
```

##Roadmap
* Refactoring of editor.html
* Make it more customizable
* Better documentation
* More testing
* Any other suggestions are welcome!

##Support
Written for TinyMCE 4.x
I have written this plugin in a couple hours, so please report issues if you find any.
Written for TinyMCE 4.x.
Please note: I have written this plugin in a couple hours, so please report issues if you find any.
Make sure to check out the browser support of <a href="http://codemirror.net/#browsersupport">CodeMirror</a> as well if you run into any problems.

##License
Expand Down

0 comments on commit a22f581

Please sign in to comment.