README.md in versionaire-3.3.1 vs README.md in versionaire-4.0.0
- old
+ new
@@ -1,10 +1,10 @@
# Versionaire
[](http://badge.fury.io/rb/versionaire)
-[](https://codeclimate.com/github/bkuhlmann/versionaire)
-[](https://codeclimate.com/github/bkuhlmann/versionaire)
+[](https://codeclimate.com/github/bkuhlmann/versionaire/maintainability)
+[](https://codeclimate.com/github/bkuhlmann/versionaire/test_coverage)
[](https://gemnasium.com/bkuhlmann/versionaire)
[](https://circleci.com/gh/bkuhlmann/versionaire)
[](https://www.patreon.com/bkuhlmann)
Provides immutable, thread-safe, semantic versioning.
@@ -16,11 +16,11 @@
- [Features](#features)
- [Screencasts](#screencasts)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- - [Initialization](#initialization)
+ - [Initialization](#initialization)
- [Equality](#equality)
- [Value (`#==`)](#value-)
- [Hash (`#eql?`)](#hash-eql)
- [Case (`#===`)](#case-)
- [Identity (`#equal?`)](#identity-equal)
@@ -51,33 +51,24 @@
[](https://asciinema.org/a/40455)
## Requirements
-0. [Ruby 2.4.x](https://www.ruby-lang.org)
+0. [Ruby 2.5.x](https://www.ruby-lang.org)
## Setup
-For a secure install, type the following (recommended):
+Type the following to install:
- gem cert --add <(curl --location --silent https://www.alchemists.io/gem-public.pem)
- gem install versionaire --trust-policy MediumSecurity
-
-NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
-while allowing the installation of unsigned dependencies since they are beyond the scope of this
-gem.
-
-For an insecure install, type the following (not recommended):
-
gem install versionaire
Add the following to your Gemfile:
gem "versionaire"
## Usage
-## Initialization
+### Initialization
A new version can be initialized in a variety of ways:
Versionaire::Version.new # "0.0.0"
Versionaire::Version.new major: 1 # "1.0.0"