Merge pull request #3 from sosedoff/fixes

Update the README. Thanks to @sosedoff.

Author: sishen

.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store

Gemfile

@@ -1,6 +1,5 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in omniauth-bitbucket.gemspec
 gemspec
 
 group :development, :test do

README.md

@@ -1,21 +1,56 @@
 # OmniAuth Bitbucket
 
-This is the OmniAuth strategy for authenticating to Bitbucket. To
-use it, you'll need to sign up for an OAuth consumer key and Secret
-by sending emails to [Bitbucket Support](mailto:support@bitbucket.org).
+This is the OmniAuth strategy for authenticating to [Bitbucket](https://bitbucket.org). 
+To use it, you'll need to signup and create a new application or use your 
+existing OAuth consumer and secret keys.
+
+## Install
+
+Add dependency to your Gemfile:
+
+```
+gem 'omniauth-bitbucket'
+```
+
+Or install manually:
+
+```
+gem install omniauth-bitbucket
+```
 
 ## Basic Usage
 
-    use OmniAuth::Builder do
-      provider :bitbucket, ENV['BITBUCKET_KEY'], ENV['BITBUCKET_SECRET']
-    end
+```ruby
+use OmniAuth::Builder do
+  provider :bitbucket, ENV['BITBUCKET_KEY'], ENV['BITBUCKET_SECRET']
+end
+```
+
+If using Rails, add an initializer `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bitbucket, 'BITBUCKET_KEY', 'BITBUCKET_SECRET'
+end
+```
 
 ## License
 
-Copyright (c) 2011 Dingding Ye.
+Copyright (c) 2011-2013 Dingding Ye.
 
-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:
+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 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 OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 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 OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

exmaples/test.rb renamed to examples/test.rb

@@ -20,8 +20,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'omniauth', '~> 1.1'
   s.add_dependency 'omniauth-oauth', '~> 1.0'
   s.add_dependency 'multi_json', '~> 1.7'
+
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rake'
 end