Skip to content
Browse files

add a bit more to the readme

  • Loading branch information...
1 parent acfb875 commit ec216d40ffae0a579877e38408deebab87b23bdb @maxogden committed Oct 17, 2012
Showing with 21 additions and 2 deletions.
  1. +21 −2 readme.md
View
23 readme.md
@@ -1,5 +1,24 @@
-## work in progress -- alpha status
+## work in progress -- still very beta
ViewKit is a fork of [UIKit](http://github.com/visionmedia/uikit) designed for mobile WebKit WebViews. Compatible with iOS4.2+ and Android 2.3+ browsers
-compile and package into `build/` with `make`
+Sorry for the lack of documentation! I'm still working on this project
+
+
+## using this
+
+- install http://github.com/jorgebastida/glue
+- compile and package into `build/` with `make`
+
+## examples
+
+here are a couple of apps I wrote that use ViewKit:
+
+http://gather.at/
+http://maxogden.github.com/india-trains-mobile/
+
+you can also open index.html in this repo to see a simple example
+
+## license
+
+BSD

0 comments on commit ec216d4

Please sign in to comment.
Something went wrong with that request. Please try again.