31.10.17

README.md

@@ -8,84 +8,13 @@ Simple to use. Contains 14 animation effects and can use images.
 <i>Plugin works on all browsers and IE10+ (for css3 animation effects).</i>
 <br>
 
-<a href="http://vadimsva.github.io/waitMe/" target="_blank"><b>DEMO</b></a>
+Documentation
+=============
 
+<a href="http://vadimsva.github.io/waitMe/" target="_blank"><b>DOCUMENTATION & EXAMPLES</b></a>
 
-<h4>Direct links to libs</h4>
-<a href="http://vadimsva.github.io/waitMe/waitMe.js" target="_blank"><b>waitMe.js</b></a> [8.9Kb]<br>
-<a href="http://vadimsva.github.io/waitMe/waitMe.min.js" target="_blank"><b>waitMe.min.js</b></a> [3.7Kb]<br>
-<a href="http://vadimsva.github.io/waitMe/waitMe.css" target="_blank"><b>waitMe.css</b></a> [15.3Kb]<br>
-<a href="http://vadimsva.github.io/waitMe/waitMe.min.css" target="_blank"><b>waitMe.min.css</b></a> [14Kb]
 
-<br><br>
+License
+=======
 
-<p><i>$(container).waitMe({param1 : value1, param2 : value2, ...});</i></p>
-
-<h5>Parameters</h5>
-- <code><b>effect</b></code> - animation effect (string).<br>
-Use: <code>'bounce'</code> - default, <code>none</code>, <code>rotateplane</code>, <code>stretch</code>, <code>orbit</code>, <code>roundBounce</code>, <code>win8</code>, <code>win8_linear</code>, <code>ios</code>, <code>facebook</code>, <code>rotation</code>, <code>timer</code>, <code>pulse</code>, <code>progressBar</code>, <code>bouncePulse</code>, <code>img</code>.<br>
-- <code><b>text</b></code> - place text under the effect (string).<br>
-Use: <code>'text'</code>.<br>
-- <code><b>bg</b></code> - background for container (string).<br>
-Use: <code>'rgba(255,255,255,0.7)'</code>. You can use color and image.<br>
-- <code><b>color</b></code> - color for background animation and text (string, array).<br>
-Use: <code>'#000'</code>, <code>['','',...]</code> - you can use multicolor for effect<br>
-- <code><b>maxSize</b></code> - set max size for elem animation (string).<br>
-Use: <code>40</code>. By default, use empty string.<br>
-- <code><b>textPos</b></code> - change text position (string).<br>
-Use: <code>'vertical'</code> - default, <code>'horizontal'</code>.<br>
-- <code><b>fontSize</b></code> - change font size (string).<br>
-Use: <code>'18px'</code>. By default, use empty string.<br>
-- <code><b>source</b></code> - url to image (string).<br>
-Use: <code>'url'</code>. By default, use empty string. Use with <code>effect: 'img'</code>.<br>
-- <code><b>onClose</b></code> - code execution after closed (function).<br>
-Use: <code>function(){}</code><br>
-<br>
-
-<h5>Methods</h5>
-- <code><b>hide</b></code> - for close waitMe.<br>
-Use: <code>$(container).waitMe("hide");</code><br>
-<br>
-
-<h5>Triggers</h5>
-- <code><b>close</b></code> - execution after closed.<br>
-Use: <code>$('.waitMe').on('close', function() {});</code><br>
-<br>
-
-
-<b>Don't use as element container non block elements such as table, input, textarea and etc. Use div, span or body (you may use html and it would be work as body).</b><br>
-
-<br><br>
-
-<h5>Animation during the initial page load</h5>
-<pre>
-&lt;body class="waitMe_body"&gt;
-  &lt;div class="waitMe_container progress" style="background:#fff"&gt;
-    &lt;div style="background:#000"&gt;&lt;/div&gt;
-  &lt;/div&gt;
-&lt;/body&gt;
-</pre>
-
-<pre>
-&lt;body class="waitMe_body"&gt;
-  &lt;div class="waitMe_container working" style="background:#fff"&gt;
-    &lt;div style="background:#000"&gt;&lt;/div&gt;
-  &lt;/div&gt;
-&lt;/body&gt;
-</pre>
-
-<pre>
-&lt;body class="waitMe_body"&gt;
-  &lt;div class="waitMe_container img" style="background:#fff"&gt;
-    &lt;div style="background:url('img.png')"&gt;&lt;/div&gt;
-  &lt;/div&gt;
-&lt;/body&gt;
-</pre>
-
-<pre>
-&lt;body class="waitMe_body"&gt;
-  &lt;div class="waitMe_container text" style="background:#fff"&gt;
-    &lt;div style="color:#000"&gt;Loading&lt;/div&gt;
-  &lt;/div&gt;
-&lt;/body&gt;
-</pre>
+The MIT License (MIT)