Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
David Balatero committed Jun 16, 2009
1 parent dba3f99 commit 849db25
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.markdown
@@ -1,13 +1,18 @@
evri_rpx
========
The evri_rpx library provides an wrapper around RPXNow's universal sign-on API.
The `evri_rpx` library provides an wrapper around RPXNow's universal sign-on API.

Features
--------
- Clean and simple API design
- SSL certificate validation
- Implements all RPX API calls
- Full SSL certificate validation
- Implements all RPX API calls, including ones available at the Pro level
- 100% spec coverage
- Clear documentation (and if not, let me know!)

TODO
----
- Rails helper methods for building up the iframe/popup widget code.

Usage/Install
-------------
Expand All @@ -18,11 +23,11 @@ Usage/Install
Examples
========

Here are examples of the features in evri_rpx. As well, you can browse the RDocs here: http://rdoc.info/projects/dbalatero/evri_rpx
Here are examples of the features in `evri_rpx`. As well, you can browse the RDocs here: [http://rdoc.info/projects/dbalatero/evri_rpx](http://rdoc.info/projects/dbalatero/evri_rpx)

All interaction with the API goes through the public methods Evri::RPX::Session, which often return complex objects (see RDocs for all the methods available).
All interaction with the API goes through the public methods in `Evri::RPX::Session`, which often return complex objects. See [RDocs](http://rdoc.info/projects/dbalatero/evri_rpx) for all the methods available on these objects.

To see examples of raw JSON responses from RPX, see http://github.com/dbalatero/evri_rpx/tree/master/spec/fixtures
To see examples of raw JSON responses from RPX, see [http://github.com/dbalatero/evri_rpx/tree/master/spec/fixtures](http://github.com/dbalatero/evri_rpx/tree/master/spec/fixtures)

Validating tokens in your Rails app
-----------------------------------
Expand Down Expand Up @@ -132,10 +137,6 @@ provider? methods for Users
# post an article to facebook via FB connect
end

TODO
====
- Helper methods for building up the iframe, forms, etc.

Copyright
=========
Copyright (c) 2009 David Balatero, Evri, Inc. <dbalatero at evri dot com>. See LICENSE for details.

0 comments on commit 849db25

Please sign in to comment.