From e03a4512023eabbef4675306c1435854117a2241 Mon Sep 17 00:00:00 2001 From: Hans Christian Reinl Date: Fri, 19 Apr 2013 00:51:11 +0200 Subject: [PATCH] Add README content - docs Closes #3 --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/README.md b/README.md index e69de29..97e6165 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,64 @@ +# CSS Modals + +Modals build out of pure CSS + + +## What is it + +### Build with pure CSS +CSS Modal is build out of pure CSS. JavaScript is only for sugar. This makes +them perfectly accessible. + +### Optimized for mobile +The modals are designed using responsive web design methods. They work on all +screen sizes from a small mobile phone up to high resolution screens. + +### Use as Sass plugin +You can use CSS Modal as [Sass](http://sass-lang.com/) plugin and apply it to +your custom classes. No need to understand all the code. + +### A few other advantages +accessible, cross-browser, media-adaptive, small and fast! + + +## How to use + +Please visit [the website's section](http://drublic.github.io/css-modal/#howto-markup) +on how to use the CSS Modal. + + +## Browser Support + +This modal is designed to work on all modern browsers. This does not include +Internet Explorer 7 or lower. + + +## Heads up + +Please be aware that you need to stop playing videos or audio manually after +hiding the modal. + +There is an event that is fired on the modal itself after the modal is show +which is called `cssmodal:show` and an event after the modal is hidden called +`cssmodal:hide`. + +There events are not fired in IE8. Please be aware of that and use jQuery or +something else to create custom events. + + +# Bug Reports And Feature Requests + +If you got something that's worth including into the project please +[open an issue](https://github.com/drublic/css-modal/issues) for further +discussion. + +Please see the [section on contributing](http://drublic.github.io/css-modal/#contributing) +on the website. + + +## Contributors + +This is a project by [Hans Christian Reinl](http://drublic.de). + +A special thanks goes out to [@helloanselm](https://twitter.com/helloanselm) for +providing feedback and contributions in general