🦆 Ducktrails

Automatically generates breadcrumbs based on routes.

Warning: This API is still alpha; we welcome PRs and ideas as issues.

Ducktails Theme

Usage

For basic applications using a restful architecture, ducktrails should generate the breadcrumbs automatically.

For example, if the uri is /users/#{user-id}/posts/#{post-id}

Would render:

Home / All Users / user-name / All Posts / post-name

Installation

Add this line to your application's Gemfile:

gem 'ducktrails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ducktrails

Contributing

Please refer to each project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
    1. bundle
    2. Create the test db bundle exec rake --rakefile test/dummy/Rakefile db:setup
    3. bundle exec rake to test.
  3. Ensure your test coverage is A+
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

The gem is available as open source under the terms of the MIT License.