Permalink
Browse files

#10 create readme and license file

  • Loading branch information...
1 parent b9c1375 commit d14e027b94ffb2fdc2c490f5546d9b2bfd7b5842 @aFarkas committed Oct 21, 2010
Showing with 74 additions and 0 deletions.
  1. +20 −0 MIT-LICENSE.txt
  2. +54 −0 readme.md
View
@@ -0,0 +1,20 @@
+Copyright (c) 2010 Alexander Farkas, http://protofunc.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,54 @@
+[Webshims Lib](http://aFarkas.github.com/webshim/demos/index.html) - The polyfilling, capability based loading JavaScript Libary
+================================
+
+How To Use
+------------------
+
+* Simply [download Webshims Lib](http://github.com/downloads/aFarkas/webshim/webshims-latest.zip/qr_code) and put the js-webshim-folder in your project
+* Include the JavaScript:
+
+---------------
+<script src="js-webshim/minified/polyfiller.js"></script>
+
+<script>
+ //path is path of polyfiller.js-code + shims/ $.webshims.loader.basePath += 'shims/';
+ //load and implement all unsupported features
+ $.webshims.polyfill();
+</script>
+---------------
+
+* Wait till the implementation is ready and work with it:
+
+--------------
+<script>
+ $.webshims.ready('geolocation json-storage', function(){
+ //work with geolocation, JSON and localStorage
+ var userData = JSON.parse(localStorage.getItem('userData')) || {visits: 0};
+ //...
+ $(function(){
+ //work with geolocation JSON and localStorage *and the DOM*
+ $('#visits').html(userData.visits);
+ //...
+ });
+ });
+</script>
+--------------
+
+[more informations and demos](http://aFarkas.github.com/webshim/demos/index.html)
+
+
+License
+---------------------------------------
+
+The Webshims Lib core is licensed under the [MIT-License](http://aFarkas.github.com/webshim/MIT-LICENSE.txt). Note: Webshims Lib uses many greate third party scripts.
+
+
+
+Questions?
+----------
+
+If you have any questions, please feel free to ask them on the Using jQuery Plugins
+forum, which can be found here:
+[http://forum.jquery.com/using-jquery-plugins](http://forum.jquery.com/using-jquery-plugins)
+
+**Please tag your questions with 'webshims' or 'polyfill'.**

0 comments on commit d14e027

Please sign in to comment.