aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorZachary Scott <mail@zzak.io>2016-08-16 23:57:18 +0900
committerZachary Scott <mail@zzak.io>2016-08-16 23:57:18 +0900
commit7295b9178c48eea1a09c3d9cce221ad0db9f93c1 (patch)
treefec9555b75699969be5f5536234e0c986fe45228 /README.md
parent580c6d4a51d7a8713e46b06474341e1297d4de13 (diff)
downloadruby-openssl-7295b9178c48eea1a09c3d9cce221ad0db9f93c1.tar.gz
Clean up README and CONTRIBURING :nail_care:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index 97dd3e55..a478d58f 100644
--- a/README.md
+++ b/README.md
@@ -20,16 +20,27 @@ You may need to specify the path where OpenSSL is installed.
gem install openssl -- --with-openssl-dir=/opt/openssl
```
+Alternatively, you can install the gem with `bundler`:
+
+```ruby
+# Gemfile
+gem 'openssl'
+# or specify git master
+gem 'openssl', github: 'ruby/openssl'
+```
+
+After doing `bundle install`, you should have the gem installed in your bundle.
+
## Usage
-After you install it, you can require "openssl" in your application.
+Once installed, you can require "openssl" in your application.
```ruby
require "openssl"
```
-If you are using Ruby 2.3, you may need to tell RubyGems to prefer the gem
-version of openssl.
+If you are using Ruby 2.3, you may activate the gem version of openssl,
+instead of using the default gem packaged with the Ruby installation.
```ruby
gem "openssl"
@@ -51,5 +62,5 @@ Please read CONTRIBURING.md for instructions.
## Security
-Security issues should be reported following the process described in the
-[Security page on ruby-lang.org](https://www.ruby-lang.org/en/security/).
+Security issues should be reported to ruby-core by following the process
+described on ["Security at ruby-lang.org"](https://www.ruby-lang.org/en/security/).