README.md in auther-5.0.1 vs README.md in auther-6.0.0
- old
+ new
@@ -2,20 +2,20 @@
[](http://badge.fury.io/rb/auther)
[](https://codeclimate.com/github/bkuhlmann/auther)
[](https://codeclimate.com/github/bkuhlmann/auther)
[](https://gemnasium.com/bkuhlmann/auther)
-[](http://travis-ci.org/bkuhlmann/auther)
+[](https://travis-ci.org/bkuhlmann/auther)
[](https://www.patreon.com/bkuhlmann)
Provides simple, form-based authentication for apps that need security but don't want to deal with the clunky UI
of HTTP Basic Authentication or something as heavyweight as [Devise](https://github.com/plataformatec/devise). It
doesn't require a database and is compatible with password managers like [1Password](https://agilebits.com/onepassword)
making for a pleasent user experience.
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
# Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Setup](#setup)
@@ -27,17 +27,18 @@
- [View](#view)
- [Controller](#controller)
- [Logging](#logging)
- [Troubleshooting](#troubleshooting)
- [Tests](#tests)
+- [Versioning](#versioning)
- [Code of Conduct](#code-of-conduct)
- [Contributions](#contributions)
- [License](#license)
- [History](#history)
- [Credits](#credits)
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
# Features
- Supports form-based authentication compatible with password managers like
[1Password](https://agilebits.com/onepassword).
@@ -58,18 +59,18 @@
- Provides a generator for easy install and setup within an existing project.
- Provides auto-redirection to requested path for verified credentials.
# Requirements
-0. [MRI 2.x.x](http://www.ruby-lang.org).
-0. [Ruby on Rails 4.2.x](http://rubyonrails.org).
+0. [Ruby 2.x.x](https://www.ruby-lang.org).
+0. [Ruby on Rails 5.x.x](http://rubyonrails.org).
# Setup
For a secure install, type the following from the command line (recommended):
- gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
+ gem cert --add <(curl --location --silent https://www.alchemists.io/gem-public.pem)
gem install auther --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.
@@ -233,10 +234,18 @@
To test, run:
bundle exec rake
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
# Code of Conduct
Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
you agree to abide by its terms.
@@ -245,14 +254,14 @@
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
# License
Copyright (c) 2014 [Alchemists](https://www.alchemists.io).
-Read the [LICENSE](LICENSE.md) for details.
+Read [LICENSE](LICENSE.md) for details.
# History
-Read the [CHANGELOG](CHANGELOG.md) for details.
+Read [CHANGES](CHANGES.md) for details.
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
# Credits
Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).