From 7b2069170b7f96cb310541097cad313e8547f07c Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Wed, 16 Dec 2009 14:51:27 +0200 Subject: [PATCH] added readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9639414 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# PastryKit + +If you don't know what PastryKit is, you should go read John Gruber's [PastryKit][dfpk] article on [Daring Fireball][df]. In short it's a Javascript framework for iPhone WebApps, which simulates the nice scrolling and navigation in native iPhone apps. It was (presumably) developed by Apple for the [iPhone User Guide][ipug] (set browser user agent to MobileSafari 3.x to view) and good few months ago, but nothing has been officially released or mentioned about PastryKit. + + +## About PastryKit.git + +This is simply an attempt to bring more attention to PastryKit. And by doing so helping the community to improve the kind and quality of Web Apps that can be built for the iPhone and iPod Touch. + +I used [jsbeautifier.org][jsb] to reformat the PastryKit source into a more humanly readable format, as well as fixed about 500 warnings thrown by the [JSLint][jslint] validator. + + +## Testing + +To test PasrtyKit in action, you will need to serve up the repo via HTTP, and open `mobile/index.html`, as it pulls data from the `Contents` folder via Ajax. + + +## Forking & Development + +Please feel free to fork and improve/modify PastryKit.git. I will happily merge any improvements back into my repository. + + +## Legal / License + +I would assume Apple has copyright on PastryKit, but no copyright information is given anywhere in the source files from what I can find, so for now all I'll say is, it's most likely owned by Apple. Hopefully they won't demand I remove this project from GitHub, but incase they do request a removal, I will comply without any hesitation, and I would have to demand that any forks of PastryKit.git also be removed. + +P.S. Apple, if you are reading this, I just want to bring your awesome code to light and see more advanced web apps being built. So don't sue me ok? :) + + + +[df]: http://daringfireball.net/ +[dfpk]: http://daringfireball.net/2009/12/pastrykit +[ipug]: http://help.apple.com/iphone/3/mobile/ +[jsb]: http://jsbeautifier.org/ +[jslint]: http://www.jslint.com/ \ No newline at end of file