Skip to content
Browse files

Adding README.

  • Loading branch information...
1 parent 3c3e568 commit f22bcdf7b98e7030796e862875c3724ac344fa14 @arunagw committed Nov 8, 2011
Showing with 35 additions and 0 deletions.
  1. +35 −0 README.md
View
35 README.md
@@ -0,0 +1,35 @@
+# OmniAuth PicPlz
+
+This gem contains the PicPlz strategy for OmniAuth.
+
+PicPlz uses the OAuth2 flow, you can read about it here: https://sites.google.com/site/picplzapi/authentication
+
+## How To Use It
+
+So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
+
+ gem 'omniauth-picplz'
+
+You can pull them in directly from github e.g.:
+
+ gem 'omniauth-picplz', :git => 'https://github.com/arunagw/omniauth-picplz.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+ Rails.application.config.middleware.use OmniAuth::Builder do
+ provider :picplz, "consumer_key", "consumer_secret"
+ end
+
+You will obviously have to put in your key and secret, which you get when you register your app with PicPlz (they call them API Key and Secret Key).
+
+Now just follow the README at: https://github.com/intridea/omniauth
+
+## License
+
+Copyright (c) 2011 by Arun Agrawal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS

0 comments on commit f22bcdf

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