README.md in navigator-1.3.0 vs README.md in navigator-1.4.0
- old
+ new
@@ -1,16 +1,42 @@
-# Overview
+# Navigator
-[![Gem Version](https://badge.fury.io/rb/navigator.png)](http://badge.fury.io/rb/navigator)
-[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/navigator.png)](https://codeclimate.com/github/bkuhlmann/navigator)
-[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/navigator/coverage.png)](https://codeclimate.com/github/bkuhlmann/navigator)
-[![Gemnasium Status](https://gemnasium.com/bkuhlmann/navigator.png)](https://gemnasium.com/bkuhlmann/navigator)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/navigator.png)](http://travis-ci.org/bkuhlmann/navigator)
-[![Gittip](http://img.shields.io/gittip/bkuhlmann.svg)](https://www.gittip.com/bkuhlmann)
+[![Gem Version](https://badge.fury.io/rb/navigator.svg)](http://badge.fury.io/rb/navigator)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/navigator.svg)](https://codeclimate.com/github/bkuhlmann/navigator)
+[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/navigator/coverage.svg)](https://codeclimate.com/github/bkuhlmann/navigator)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/navigator.svg)](https://gemnasium.com/bkuhlmann/navigator)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/navigator.svg)](https://travis-ci.org/bkuhlmann/navigator)
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
Enhances Rails with a DSL for menu navigation.
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+ - [Unordered List (simple)](#unordered-list-simple)
+ - [Unordered List (with attributes)](#unordered-list-with-attributes)
+ - [Unordered List (with multiple data attributes)](#unordered-list-with-multiple-data-attributes)
+ - [Nav (with links)](#nav-with-links)
+ - [Foundation Menu](#foundation-menu)
+ - [Bootstrap Dropdown](#bootstrap-dropdown)
+ - [Menu Helpers](#menu-helpers)
+- [Customization](#customization)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
# Features
- Provides a DSL for building navigation menus.
- Supports auto-detection/highlighting of active menu items based on current path (customizable for non-path usage too).
- Supports sub-menus, nested tags, HTML attributes, etc.
@@ -40,11 +66,11 @@
- button
- Provides `link`, `image`, and `item` convenience methods for succinct ways to build commonly used menu elements.
# Requirements
-0. [MRI 2.x.x](http://www.ruby-lang.org).
+0. [MRI 2.x.x](https://www.ruby-lang.org).
0. [Ruby on Rails 4.1.x](http://rubyonrails.org).
# Setup
For a secure install, type the following from the command line (recommended):
@@ -236,17 +262,17 @@
end
When building images, the default is:
navigation "nav", activator: activator do
- img attributes: {src: "http://placehold.it/50x50", alt: "Example"}
+ img attributes: {src: "https://placehold.it/50x50", alt: "Example"}
end
...but can be written as:
navigation "nav", activator: activator do
- image "http://placehold.it/50x50", "Example"
+ image "https://placehold.it/50x50", "Example"
end
When building menu items, the default is:
navigation "nav", activator: activator do
@@ -349,10 +375,10 @@
# Tests
To test, run:
- bundle exec rspec spec
+ bundle exec rake
To test the dummy application, run:
cd spec/dummy
bin/rails server