Browse Source

Update README

Tim Fletcher 14 years ago
parent
commit
e32d49094b
1 changed files with 28 additions and 5 deletions
  1. 28 5
      README.txt

+ 28 - 5
README.txt

@@ -10,18 +10,41 @@ Quick start (client usage):
   ...
   ...
   2> RequestTokenURL = "http://term.ie/oauth/example/request_token.php".
   2> RequestTokenURL = "http://term.ie/oauth/example/request_token.php".
   ...
   ...
-  3> {ok, ResponseR} = oauth:get(RequestTokenURL, [], Consumer, "", "").
+  3> {ok, RequestTokenResponse} = oauth:get(RequestTokenURL, [], Consumer).
   ...
   ...
-  4> ParamsR = oauth_http:response_params(ResponseR).
+  4> RequestTokenParams = oauth:params_decode(RequestTokenResponse).
   ...
   ...
-  5> TokenR = oauth:token(ParamsR).
+  5> RequestToken = oauth:token(RequestTokenParams).
   ...
   ...
-  6> TokenSecretR = oauth:token_secret(ParamsR).
+  6> RequestTokenSecret = oauth:token_secret(RequestTokenParams).
   ...
   ...
   7> AccessTokenURL = "http://term.ie/oauth/example/access_token.php".
   7> AccessTokenURL = "http://term.ie/oauth/example/access_token.php".
   ...
   ...
-  8> {ok, ResponseA} = oauth:get(AccessTokenURL, [], Consumer, TokenR, TokenSecretR).
+  8> {ok, AccessTokenResponse} = oauth:get(AccessTokenURL, [], Consumer, RequestToken, RequestTokenSecret).
   ...
   ...
+  9> AccessTokenParams = oauth:params_decode(AccessTokenResponse).
+  ...
+  10> AccessToken = oauth:token(AccessTokenParams).
+  ...
+  11> AccessTokenSecret = oauth:token_secret(AccessTokenParams).
+  ...
+  12> URL = "http://term.ie/oauth/example/echo_api.php".
+  ...
+  13> {ok, Response} = oauth:get(URL, [{"hello", "world"}], Consumer, AccessToken, AccessTokenSecret).
+  ...
+  14> oauth:params_decode(Response).
+  ...
+
+
+Consumer credentials are represented as follows:
+
+  {Key::string(), Secret::string(), plaintext}
+
+  {Key::string(), Secret::string(), hmac_sha1}
+
+  {Key::string(), RSAPrivateKeyPath::string(), rsa_sha1}  % client side
+
+  {Key::string(), RSACertificatePath::string(), rsa_sha1}  % server side
 
 
 
 
 The percent encoding/decoding implementations are based on those found in
 The percent encoding/decoding implementations are based on those found in