Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/ratchet.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorConnor Sears <connors@users.noreply.github.com>2014-02-25 08:39:14 +0400
committerConnor Sears <connors@users.noreply.github.com>2014-02-25 08:39:14 +0400
commit51706c1ff8ad81e1874bd82ba2b6f9439c7f3925 (patch)
treebfa4cac24ddf6441848758cf56d1637c11e42997 /README.md
parent1f0f5fda6d81deb4b640efbdb586f011d5fb61ae (diff)
parent3af992fc0d3b3eea475c71985bfb9e98b01e1f06 (diff)
Merge pull request #213 from maker/2.0.0-wip
WIP: Ratchet 2
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 24 insertions, 18 deletions
diff --git a/README.md b/README.md
index 36c0f89..2dcbfe9 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,34 @@
-# Ratchet v1.0.2
+# Ratchet v2.0 [![devDependencies](https://david-dm.org/maker/ratchet/dev-status.png?theme=shields.io)](https://david-dm.org/maker/ratchet#info=devDependencies)
-Prototype mobile apps with simple HTML, CSS and JS components.
+Build mobile apps with simple HTML, CSS, and JS components.
## Getting Started
-- Clone the repo `git clone git@github.com:maker/ratchet.git` or just [download](http://maker.github.com/ratchet/ratchet.zip) the bundled CSS and JS
-- [Read the docs](http://maker.github.com/ratchet) to learn about the components and how to get a prototype on your phone
+- 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!
-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/maker/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).
+
+## Documentation
+
+Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://goratchet.com>. The docs may also be run locally.
+
+### Running documentation locally
+
+1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation).
+2. From the root `/ratchet/docs` directory, run `jekyll serve` in the command line.
+3. Open <http://localhost:4000> in your browser, and boom!
+
+Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
## Support
-Ratchet was developed to support iOS 5+ for iPhone. Questions or discussions about Ratchet should happen in the [Google group](https://groups.google.com/forum/#!forum/goratchet) or hit us up on Twitter [@goRatchet](http://www.twitter.com/goratchet).
+Questions or discussions about Ratchet should happen in the [Google group](https://groups.google.com/forum/#!forum/goratchet) or hit us up on Twitter [@GoRatchet](https://twitter.com/goratchet).
## Reporting bugs & contributing
-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).
+Please file a GitHub issue to [report a bug](https://github.com/twbs/ratchet/issues). When reporting a bug, be sure to follow the [contributor guidelines](https://github.com/twbs/ratchet/blob/master/CONTRIBUTING.md).
## Troubleshooting
@@ -29,22 +41,16 @@ A small list of "gotchas" are provided below for designers and developers starti
- 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>```
-## Authors
-
-Dave Gamache
-
-- http://twitter.com/dhg
-- http://github.com/dhg
+## Maintainer
Connor Sears
-- http://twitter.com/connors
-- http://github.com/connors
+- <https://twitter.com/connors>
+- <https://github.com/connors>
+
-Jacob Thornton
-- http://twitter.com/fat
-- http://github.com/fat
+Created by Connor Sears, Dave Gamache, and Jacob Thornton
## License