diff --git a/README.md b/README.md index 1f816b7..90f52bb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Build mobile apps with simple HTML, CSS, and JS components. - Clone the repo with `git clone https://github.com/twbs/ratchet.git` or just [download](http://github.com/twbs/ratchet/archive/v2.0.0.zip) the bundled CSS and JS - [Read the docs](http://goratchet.com) to learn about the components and how to get a prototype on your phone -- We will have example apps to check out very soon! +- [Check out examples](http://goratchet.com/examples/) Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the [tagged downloads](https://github.com/twbs/ratchet/tags). @@ -37,11 +37,11 @@ Please file a GitHub issue to [report a bug](https://github.com/twbs/ratchet/iss 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) + - 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 ``` to serve up the files in the current directory to ```http://localhost:``` +- 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 ``` to serve up the files in the current directory to ```http://localhost:``` ## Versioning