git.roojs.org Git - ratchet/blob - README.md

   1 # Ratchet
   2
   3 Prototype mobile apps with simple HTML, CSS and JS components.
   4
   5 ## Getting Started
   6
   7 - Clone the repo `git clone git@github.com:maker/ratchet.git` or just [download]() the bundled CSS and JS
   8 - [Read the docs](http://maker.github.com/ratchet) to learn about the components and how to get a prototype on your phone
   9 - We will have example apps to check out very soon!
  10
  11 ## Support
  12
  13 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).
  14
  15 ## Reporting bugs & contributing
  16
  17 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).
  18
  19 ## Future features
  20
  21 Ratchet is just getting started. Here are some of the immediate features we're thinking about:
  22
  23 - Shelf (exposable left hand navigation a la Path or Facebook)
  24 - Gridviews
  25 - Notifications
  26 - Slide control
  27 - More list views options
  28 - Improved active states (especially for lists)
  29 - Docking list dividers
  30 - Touch library for richer touch events (swipes, long press, etc)
  31 - Autocomplete
  32 - Hiding title bar (hides with scroll)
  33
  34 Even these are just the short-term goals though. We eventually want to extend Ratchet beyond the prototying for iPhone and create HTML/CSS/JS components for iPad and Android devices. Our dream is that Ratchet becomes the best way to create mobile experiences with web standard languages.
  35
  36 ## Authors
  37
  38 Dave Gamache
  39
  40 - http://twitter.com/dhg
  41 - http://github.com/dhgamache
  42
  43 Connor Sears
  44
  45 - http://twitter.com/connors
  46 - http://github.com/connors
  47
  48 Jacob Thornton
  49
  50 - http://twitter.com/fat
  51 - http://github.com/fat
  52
  53
  54 ## License
  55
  56 Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).