Build mobile apps with simple HTML, CSS, and JS components.
Build mobile apps with simple HTML, CSS, and JS components.
@ -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
- 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
- [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).
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,27 @@ 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
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:
- 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)
- 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)
- 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.
- 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.
- 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>```
- 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>```
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Ratchet is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.
Releases will be numbered with the following format:
`<major>.<minor>.<patch>`
And constructed with the following guidelines:
- Breaking backward compatibility **bumps the major** while resetting minor and patch
- New additions without breaking backward compatibility **bumps the minor** while resetting the patch
- Bug fixes and misc changes **bumps only the patch**
For more information on SemVer, please visit <http://semver.org/>.
<adata-ignore="push"href="https://twitter.com/share"class="twitter-share-button"data-url="http://goratchet.com"data-text="Ratchet – Build mobile apps with simple HTML, CSS, and JS components."data-via="GoRatchet">Tweet</a>
<adata-ignore="push"href="https://twitter.com/share"class="twitter-share-button"data-url="http://goratchet.com"data-text="Ratchet – Build mobile apps with simple HTML, CSS, and JS components."data-via="GoRatchet">Tweet</a>
@ -14,7 +14,7 @@
</li>
</li>
</ul>
</ul>
<pclass="docs-footer-text">Code licensed under the MIT license and the docs are licensed under CC BY 3.0. Ratchet version 2.0.0 was lovingly crafted by <ahref="https://twitter.com/connors"data-ignore="push">Connor Sears</a>.</p>
<pclass="docs-footer-text">Code licensed under the <ahref="https://github.com/twbs/ratchet/blob/master/LICENSE"data-ignore="push">MIT License</a> and the docs are licensed under <ahref="https://github.com/twbs/ratchet/blob/master/docs/LICENSE"data-ignore="push">CC BY 3.0</a>. Ratchet version 2.0.0 was lovingly crafted by <ahref="https://twitter.com/connors"data-ignore="push">Connor Sears</a>.</p>
connors
11 years ago
