Skip to content
Browse files

Remove plain README

  • Loading branch information...
1 parent 9da32c0 commit d98b9c18cdc71c1f04c96734014a573aaeedbfae @tim committed Feb 12, 2012
Showing with 0 additions and 57 deletions.
  1. +0 −57 README.txt
View
57 README.txt
@@ -1,57 +0,0 @@
-An Erlang OAuth implementation.
-
-Quick start (client usage):
-
- $ make
- ...
- $ erl -pa ebin -s crypto -s inets
- ...
- 1> Consumer = {"key", "secret", hmac_sha1}.
- ...
- 2> RequestTokenURL = "http://term.ie/oauth/example/request_token.php".
- ...
- 3> {ok, RequestTokenResponse} = oauth:get(RequestTokenURL, [], Consumer).
- ...
- 4> RequestTokenParams = oauth:params_decode(RequestTokenResponse).
- ...
- 5> RequestToken = oauth:token(RequestTokenParams).
- ...
- 6> RequestTokenSecret = oauth:token_secret(RequestTokenParams).
- ...
- 7> AccessTokenURL = "http://term.ie/oauth/example/access_token.php".
- ...
- 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 ibrowse library, written by Chandrashekhar Mullaparthi.
-
-Example client/server code is at http://github.com/tim/erlang-oauth-examples.
-
-Unit tests are at http://github.com/tim/erlang-oauth-tests.
-
-Erlang/OTP R14B or greater is required for RSA-SHA1.

0 comments on commit d98b9c1

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