From cc53cd4a91f53d0bc5d921f14db65c8116f88024 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Wed, 11 Feb 2015 09:53:47 +0200 Subject: [PATCH] Update README.md to reflect the current project state. [ci skip] --- README.md | 52 +++++++++++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b0a6f35..de7f4cf 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,20 @@ Build mobile apps with simple HTML, CSS, and JS components. ## Table of contents -- [Getting started](#getting-started) -- [Documentation](#documentation) -- [Support](#support) -- [Contributing](#contributing) -- [Troubleshooting](#troubleshooting) -- [Versioning](#versioning) -- [Maintainers](#maintainers) -- [License](#license) +* [Getting started](#getting-started) +* [Documentation](#documentation) +* [Support](#support) +* [Contributing](#contributing) +* [Troubleshooting](#troubleshooting) +* [Versioning](#versioning) +* [Maintainers](#maintainers) +* [License](#license) ## Getting started -- Clone the repo with `git clone https://github.com/twbs/ratchet.git` or just [download](http://github.com/twbs/ratchet/archive/v2.0.2.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 -- [Check out examples](http://goratchet.com/examples/) +* Clone the repo with `git clone https://github.com/twbs/ratchet.git` or just [download](http://github.com/twbs/ratchet/archive/v2.0.2.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 +* [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). @@ -53,7 +53,7 @@ Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly ### Running documentation locally 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x). - - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. + * **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. 2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`. 3. From the root `/ratchet` directory, run `jekyll serve` in the command line. 4. Open in your browser, and boom! @@ -78,12 +78,12 @@ Please file a GitHub issue to [report a bug](https://github.com/twbs/ratchet/iss A small list of "gotchas" is 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 ` to serve up the files in the current directory to `http://localhost:` +* 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 ` to serve up the files in the current directory to `http://localhost:` ## Versioning @@ -95,9 +95,9 @@ Releases will be numbered with the following format: 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** +* 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 . @@ -105,14 +105,8 @@ For more information on SemVer, please visit . Connor Sears -- -- - - -Connor Montgomery - -- -- +* +* Created by Connor Sears, Dave Gamache, and Jacob Thornton.