Permalink
Browse files

Added more documentation.

Specifically about instance and minor spelling error.
  • Loading branch information...
kr1zmo committed Dec 15, 2012
1 parent 11ce7c9 commit 96c7a79c481af744c47b18e5979a32a2b735e628
Showing with 4 additions and 2 deletions.
  1. +4 −2 readme.md
View
@@ -17,6 +17,8 @@ FB.set({
```
#instance
+
+FB invocation takes an object and returns a new instance. You can pass configuration options to overide appID and appSecret
```
var instance = FB({
signedRequest: [string]
@@ -35,9 +37,9 @@ getAccessToken takes a callback
.getAccessToken([optional-signedRequest-string], [callback(err, resp)]);
```
-api takes a api method, requestjs object and callback.
+api takes an api method string, requestjs object and callback.
```
.api([api-method], [object], [callback(err, resp)]);
```
-The object in the second parameters allows valid options using the requirejs framework https://github.com/mikeal/request#requestoptions-callback (note: extra feature is https: true).
+The object in the second parameter allows valid options using the requirejs framework https://github.com/mikeal/request#requestoptions-callback (note: extra feature is https: true).

0 comments on commit 96c7a79

Please sign in to comment.