diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..42dd242 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# OpenSSL + +[](https://travis-ci.org/ruby/openssl) + +OpenSSL provides SSL, TLS and general purpose cryptography. It wraps the +OpenSSL library. + +## Installation + +The openssl gem is available at [rubygems.org](https://rubygems.org/gems/openssl). +You can install with: + +``` +gem install openssl +``` + +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 + +Once installed, you can require "openssl" in your application. + +```ruby +require "openssl" +``` + +**NOTE**: If you are using Ruby 2.3 (and not Bundler), you **must** activate +the gem version of openssl, otherwise the default gem packaged with the Ruby +installation will be used: + +```ruby +gem "openssl" +require "openssl" +``` + +## Documentation + +See https://ruby.github.io/openssl/. + +## Contributing + +Please read our [CONTRIBUTING.md] for instructions. + +## 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/). + + +[CONTRIBUTING.md]: https://github.com/ruby/openssl/tree/master/CONTRIBUTING.md |