berlin train

[ReadingsJQM.git] / readme.md

diff --git a/readme.md b/readme.md
index 687c60a..978c601 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,52 @@
-jQuery Mobile Boilerplate is meant to answer the question of "what do I need in a new jQuery Mobile project?".
+# Welcome to jQuery Mobile Boilerplate
 
-Clone this repository into a new jQuery Mobile project's directory and get started.
+"What do I need in a new jQuery Mobile project?". This project is meant to be a single place for developers to get started using jQuery Mobile. It includes icon files, robots.txt (and human).txt files, as well as an extensive snippets library that developers can use as reference.
 
-Check the snippets folder for commonly used elements, open the html file, copy and paste and you're off to the races.
\ No newline at end of file
+**Note:** The jQuery team has offered two options for CSS file inclusion. If you're planning on using a custom theme then you only need to include `jquery.mobile.structure-1.1.0.min.css`.
+
+## Quick start
+
+Clone the git repo - `git clone git@github.com:commadelimited/jQuery-Mobile-Boilerplate.git` - or [download it](https://github.com/commadelimited/jQuery-Mobile-Boilerplate/zipball/master)
+
+**Note:** By default, the links to the CSS and JS files are root relative.
+
+`<script src="/js/application.js"></script>`
+
+Boilerplate expects to be placed in the root of your website. If this is not the configuration you're using then you'll need to update these links manually.
+
+`<script src="js/application.js"></script>`
+
+## Example
+
+[View a simple demo ](http://andymatthews.net/code/jquery-mobile-boilerplate/)
+
+## Features
+
+* jQuery Mobile 1.1 Final Compatible!
+* Project ready. Download (or clone) and go!
+* The latest jQuery Mobile JS & CSS bits from CDN, with a local option.
+* The latest jQuery bits from CDN, with a local option.
+* Override files for both JS and CSS
+* Extensive UI element snippet library. Easy to copy and paste.
+* Includes Scott Jehl's fix for the [iOS orientation bug](https://github.com/scottjehl/iOS-Orientationchange-Fix)
+
+## Contributing
+
+You are invited to contribute code and suggestions to this project. The more the merrier.
+
+## Project Info
+
+* Source: http://github.com/commadelimited/jQuery-Mobile-Boilerplate
+* Twitter: [http://twitter.com/jqmbp](http://twitter.com/jqmbp)
+* Twitter: [http://twitter.com/commadelimited](http://twitter.com/commadelimited)
+
+## License
+
+### 3rd party libraries:
+
+* jQuery: MIT/GPL license
+* jQuery Mobile: MIT/GPL license
+
+### Custom bits:
+
+Public domain
\ No newline at end of file