Skip to content

Commit 9786e18

Browse files
committed
📝 Documentation
1 parent c0e9b51 commit 9786e18

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ A Ruby library for verifying and serving OpenID identities.
6565
* Comprehensive test suite
6666
* Supports both OpenID 1 and OpenID 2 transparently
6767

68+
69+
## Installation
70+
71+
Install the gem and add to the application's Gemfile by executing:
72+
73+
$ bundle add ruby-openid2
74+
75+
If bundler is not being used to manage dependencies, install the gem by executing:
76+
77+
$ gem install ruby-openid2
78+
6879
| Primary Namespace | OpenID |
6980
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7081
| gem name | [ruby-openid2](https://rubygems.org/gems/ruby-openid2) |
@@ -93,23 +104,6 @@ A Ruby library for verifying and serving OpenID identities.
93104
[aboutme]: https://about.me/peter.boling
94105
[coderme]: https://coderwall.com/Peter%20Boling
95106

96-
## Installing
97-
98-
Before running the examples or writing your own code you'll need to install
99-
the library. See the INSTALL file or use rubygems:
100-
101-
gem install ruby-openid
102-
103-
Check the installation:
104-
105-
$ irb
106-
irb> require 'rubygems'
107-
=> false
108-
irb> gem 'ruby-openid'
109-
=> true
110-
111-
The library is known to work with Ruby 1.9.2 and above on Unix, Max OS X and Win32.
112-
113107
### Note about the deprecation of stdlib gems `logger`, `rexml`, `net-http`, and `uri`
114108

115109
Versions 3.0.x were released with hard dependencies on the new stand alone gem replacements

0 commit comments

Comments
 (0)