<NME> README.md
<BEF> # MaterialNote v2.0.5

WYSIWYG editor for the web, based on materialnote.js and materializeCss.
Version 2 is currently in beta...



## Editor Api

MaterialNote is based on summernote.js, so the API is still the same.
Please visit [summernote.js api guide](http://summernote.org/deep-dive/) to deep dive.


## Settings additions

Other to the standard summernote.js settings, materialNote have some extras (take a look at official summernote guide for the [summernote.js initialization options](http://summernote.org/deep-dive/#initialization-options)).

- `popover.image`: added `['responsivity', ['responsive']]` btn group containing button to handle materialize's image responsivity class.
- `popover.link`: added `openLinkNewWindow` btn to handle `target` attribute of the link directly from the popover.
- `popover.table`: added `['materializeOptions', ['borderedTable', 'stripedTable', 'highlightedTable', 'responsiveTable', 'centeredTable']]` btn group to handle materialize's table options.
- `defaultColors.text` [String]: default text color used for recent-color button at startup.
- `defaultColors.background` [String]: default background color used for recent-color button at startup.
- `followingToolbar` [Boolean]: enable/disable following toolbar.
- `otherStaticBarClass` [String]: if your app already have a fixed positioned topBar, you will need to add here its class to let materialNote able to calculate the right offset for the editor's toolbar.


## Editor colors

If you wish to change any of the editor color, you can quickly achieve the desired result by editing file **src/sass/variables.scss**, which defines all colours used by the editor as sass variables.

After making desired changes, just run `grunt build` to create a new dist in the **dist** folder.


## Multi instances

It is provided with scss version of the stylesheet, if you use sass, to change style quickly

In this version, editor's functions that you see on this page are tested; other summernote functions such airmode, still need to be converted;

##### Materialize Overrides
The provided versione includes an override of materialize tooltips (called ckTooltip) with autoclean function for tooltips' shadow dom when the tooltipped element is destroyed (better for single-page app); this functions is also edited to have faster tooltip animations;
If you don't need/want this, you can use the standard materialize tooltip function, replacing "ckTooltip" with "tooltip" in materialNote (1 occurence) and removing "ckMaterializeOverrides.js" file and its reference in index.html;

##### Grunt
It is provided with livereload and sass version of stylesheet;
use "grunt" to execute it and point your browser on "localhost:7000" (prerequisites: ruby, sass ("gem install sass"), grunt-cli, grunt and needed plugins ("npm install"), browser livereload extension)
```


## Contribute

Some lang strings have been added in materialNote other than the ones supplied with summernote.js; by default only english and italian lang files are kept up to date in this repo; if you can help by adding missing strings for your language, please submit a pull request (thank you);

Pull requests are welcome anyway...

<MSG> Update README.md
<DFF> @@ -35,12 +35,10 @@ MaterialSummernote is not just a conversion of Summernote from bootstrap to mate
 
 It is provided with scss version of the stylesheet, if you use sass, to change style quickly
 
-In this version, editor's functions that you see on this page are tested; other summernote functions such airmode, still need to be converted;
-
 ##### Materialize Overrides
 The provided versione includes an override of materialize tooltips (called ckTooltip) with autoclean function for tooltips' shadow dom when the tooltipped element is destroyed (better for single-page app); this functions is also edited to have faster tooltip animations;
 If you don't need/want this, you can use the standard materialize tooltip function, replacing "ckTooltip" with "tooltip" in materialNote (1 occurence) and removing "ckMaterializeOverrides.js" file and its reference in index.html;
 
 ##### Grunt
 It is provided with livereload and sass version of stylesheet;
-use "grunt" to execute it and point your browser on "localhost:7000" (prerequisites: ruby, sass ("gem install sass"), grunt-cli, grunt and needed plugins ("npm install"), browser livereload extension)
\ No newline at end of file
+use "grunt" to execute it and point your browser on "localhost:7000" (prerequisites: ruby, sass ("gem install sass"), grunt-cli, grunt and needed plugins ("npm install"), browser livereload extension)

Update README.md