diff options
author | Kazuki Yamaguchi <k@rhe.jp> | 2016-07-03 21:55:03 +0900 |
---|---|---|
committer | Kazuki Yamaguchi <k@rhe.jp> | 2016-07-28 22:25:53 +0900 |
commit | 3150d3e37a385c227da037c5c5e37505c52f79a4 (patch) | |
tree | 248f30de82ab52d9de4a6b293e32c0fefc55db18 /README.md | |
parent | 9d5c823c07b576a4cce55d75392064182b2ec3bc (diff) | |
download | ruby-openssl-3150d3e37a385c227da037c5c5e37505c52f79a4.tar.gz |
Update README.md and CONTRIBUTING.md for the gem release
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 32 insertions, 17 deletions
@@ -1,40 +1,55 @@ -# Openssl +# OpenSSL [![Build Status](https://travis-ci.org/ruby/openssl.svg?branch=master)](https://travis-ci.org/ruby/openssl) -OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the OpenSSL library. +OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the +OpenSSL library. ## Installation -Add this line to your application's Gemfile: +The openssl gem is available at [rubygems.org](https://rubygems.org/gems/openssl). +You can install with: -```ruby -gem 'openssl' +``` +gem install openssl ``` -And then execute: +You may need to specify the path where OpenSSL is installed. - $ bundle +``` +gem install openssl -- --with-openssl-dir=/opt/openssl +``` -Or install it yourself as: +## Usage - $ gem install openssl +After you install it, you can require "openssl" in your application. -## Usage +```ruby +require "openssl" +``` + +If you are using Ruby 2.3, you may need to tell RubyGems to prefer the gem +version of openssl. + +```ruby +gem "openssl" +require "openssl" +``` See the documentation on OpenSSL for more usage, -and the official [openssl library](http://www.openssl.org/). +and the official [OpenSSL library](http://www.openssl.org/). ## Getting Started -1. `$ gem install rake-compiler` +1. `$ gem install rake-compiler test-unit` 2. `$ rake compile` 3. `$ rake test` ## Contributing -1. Fork it ( https://github.com/ruby/openssl/fork ) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request +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/). |