From 7295b9178c48eea1a09c3d9cce221ad0db9f93c1 Mon Sep 17 00:00:00 2001 From: Zachary Scott Date: Tue, 16 Aug 2016 23:57:18 +0900 Subject: Clean up README and CONTRIBURING :nail_care: --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'README.md') 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/). -- cgit v1.2.3