https://github.com/gui/simpler_navigation

A Rails gem to handle navigation menus and breadcrumbs.
https://github.com/gui/simpler_navigation

Last synced: 16 days ago
JSON representation

A Rails gem to handle navigation menus and breadcrumbs.

• Host: GitHub
• URL: https://github.com/gui/simpler_navigation
• Owner: GUI
• License: mit
• Created: 2023-03-01T05:22:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-23T23:16:49.000Z (10 months ago)
• Last Synced: 2024-04-13T07:58:55.395Z (7 months ago)
• Language: Ruby
• Size: 38.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Simpler Navigation

A Rails gem to handle navigation menus and breadcrumbs.

Heavily inspired by [Simple Navigation](https://github.com/codeplant/simple-navigation/tree/master), but aiming to address performance and thread safety issues with a smaller feature set.

## Installation

Install the gem and add to the application's Gemfile by executing:

    $ bundle add simpler_navigation

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install simpler_navigation

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simpler_navigation.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).