Adjusting the docs to show the modals demo for mobile devices.
[ratchet] / README.md
index 7d6b374..c267e1e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,6 +18,17 @@ Ratchet was developed to support iOS 5+ for iPhone. Questions or discussions abo
 
 Please file a Github issue to [report a bug](http://github.com/maker/ratchet/issues). When reporting a bug, be sure to follow the [contributor guidelines](https://github.com/maker/ratchet/blob/master/CONTRIBUTING.md).
 
+## Troubleshooting
+
+A small list of "gotchas" are provided below for designers and developers starting to work with Ratchet
+
+- Ratchet is designed to respond to touch events from a mobile device. In order to use mouse click events (for desktop browsing and testing), you have a few options:
+    - Enable touch event emulation in Chrome (found in the overrides tab in the web inspector preferences)
+    - Use a javascript library like fingerblast.js to emulate touch events (ideally only loaded from desktop devices)
+- Script tags containing javascript will not be executed on pages that are loaded with push.js. If you would like to attach event handlers to elements on other pages, document-level event delegation is a common solution.
+- Ratchet uses XHR requests to fetch additional pages inside the application. Due to security concerns, modern browsers prevent XHR requests when opening files locally (aka using the file:/// protocol); consequently, Ratchet does not work when opened directly as a file.
+    - A common solution to this is to simply serve the files from a local server. One convenient way to achieve this is to run ```python -m SimpleHTTPServer <port>``` to serve up the files in the current directory to ```http://localhost:<port>```
+
 ## Future features
 
 Ratchet is just getting started. Here are some of the immediate features we're thinking about:
@@ -55,4 +66,4 @@ Jacob Thornton
 
 ## License
 
-Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).
\ No newline at end of file
+Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).