Skip to content

Commit 1a8389d

Browse files
authoredMar 16, 2019
Modernize language in INSTALL.md [ci skip]
1 parent 0dfeb82 commit 1a8389d

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed
 

‎INSTALL.md

+11-17
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# Ruby OpenID Library Installation
22

3-
## Rubygems Installation
3+
## Install as a gem
44

5-
Rubygems is a tool for installing ruby libraries and their
6-
dependancies. If you have rubygems installed, simply:
5+
`ruby-openid` is distributed on [RubyGems](https://rubygems.org/).
6+
Install it:
77

88
gem install ruby-openid
99

10+
This is probably what you need.
11+
1012
## Manual Installation
1113

12-
Unpack the archive and run setup.rb to install:
14+
Unpack the archive and run `setup.rb` to install:
1315

1416
ruby setup.rb
1517

16-
setup.rb installs the library into your system ruby. If don't want to
18+
`setup.rb` installs the library into your system ruby. If don't want to
1719
add openid to you system ruby, you may instead add the `lib` directory of
18-
the extracted tarball to your RUBYLIB environment variable:
20+
the extracted tarball to your `RUBYLIB` environment variable:
1921

2022
$ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib
2123

@@ -27,21 +29,13 @@ Make sure everything installed ok:
2729
irb$> require "openid"
2830
=> true
2931

30-
Or, if you installed via rubygems:
31-
32-
$> irb
33-
irb$> require "rubygems"
34-
=> true
35-
irb$> require_gem "ruby-openid"
36-
=> true
37-
3832
## Run the test suite
3933

4034
Go into the test directory and execute the `runtests.rb` script.
4135

4236
## Next steps
4337

44-
* Run `consumer.rb` in the examples directory.
45-
* Get started writing your own consumer using OpenID::Consumer
38+
* Run `consumer.rb` in the `examples/` directory.
39+
* Get started writing your own consumer using `OpenID::Consumer`
4640
* Write your own server with `OpenID::Server`
47-
* Use the `OpenIDLoginGenerator`! Read `example/README.md` for more info.
41+
* Use the `OpenIDLoginGenerator`! Read `examples/README.md` for more info.

0 commit comments

Comments
 (0)