Better readme

newyankeecodeshop · newyankeecodeshop · commit 587a297c39d5 · 2010-12-15T22:34:54.000-07:00
diff --git a/README.markdown b/README.markdown
@@ -1,2 +1,25 @@
 # Overview
 
+GAJavaScript is a Cocoa Touch library that makes working with JavaScript easier from native code. It has a couple of important design goals:
+
+1. Make working with JavaScript objects and functions more like working with Objective-C objects and methods.
+2. Allow native applications on iOS devices to take advantage of JavaScript to support sharing code across platforms or making applications more dynamic.
+3. Don't get in the way of developers!
+
+# Classes
+
+JavaScript is accessed from Cocoa Touch using UIWebView. To that end, the main entry point of this library is a category on UIWebView. 
+
+## UIWebView+GAJavaScript
+
+This category adds accessors to access the "document" and "window" objects of the HTML document loaded in the webview.
+
+## GAScriptObject
+
+This object provides a wrapper around a JavaScript object in a UIWebView. It provides a KVC view for a JavaScript object, so that you can get and set the object's properties using valueForKey: and setValue:forKey:, as you would with other Objective-C classes.
+
+GAScriptObject handles marshaling of data between the languages. It will handle quoting strings, passing dates as "time_t" values, and dealing with sub-objects and arrays.
+
+# Using it
+
+There are unit tests in the /Tests folder that show how to use various features (and they make sure the features work!).
diff --git a/Tests/TScriptObject.m b/Tests/TScriptObject.m
@@ -71,13 +71,13 @@ - (void)testKeyValueCoding
 - (void)finishKeyValueCoding
 {
 	NSArray* kTestValues = [NSArray arrayWithObjects:
-							@"abcd", 
-							@"string 'with' quotes",
-							[NSNumber numberWithInt:400000],
-							[NSNumber numberWithFloat:0.55555],
-							[NSNull null],
-							[NSNumber numberWithBool:YES],
-							[NSDate date],
+							@"abcd",							// String
+							@"string 'with' quotes",			// String that needs escaping
+							[NSNumber numberWithInt:400000],	// Number (Integer)
+							[NSNumber numberWithFloat:0.55555],	// Number (Float)
+							[NSNull null],						// Null
+							[NSNumber numberWithBool:YES],		// Boolean
+							[NSDate date],						// Date
 							nil];
 	
 	NSInteger status = kGHUnitWaitStatusSuccess;
@@ -100,6 +100,8 @@ - (void)finishKeyValueCoding
 		}
 		else if ([testValue isKindOfClass:[NSDate class]])
 		{
+			// There will be a sub-second difference between the values due to rounding of NSTimeInterval
+			// when it's passed into JavaScript. So we validate that the times are within 1 second.
 			if ([testValue timeIntervalSinceDate:gotValue] >= 1.0)
 				status = kGHUnitWaitStatusFailure;		
 		}
