Contents

# Nitrolinks

Nitrolinks is PJAX-like library for making website navigation fast and more like
modern web apps. Nitrolinks is inspired by and borrows heavily from
[Turbolinks](https://github.com/turbolinks/turbolinks) implementation on the
Rails-side.

## Warning! Not Production-Ready
This is an experiment and not yet heavily tested. Please don't use in critical
applications.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'nitrolinks-rails'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install nitrolinks-rails
```

## Usage

Include nitrolinks in your application.js

```javascript
//= require nitrolinks
```

### Cucumber

If you are using cucumber with capybara, add this:

```ruby
# features/support/nitrolinks.rb

require 'nitrolinks/capybara/jscript'
require 'nitrolinks/capybara/wait_for_things'

World(Nitrolinks::Capybara::Jscript)
World(Nitrolinks::Capybara::WaitForThings)
```

Then on your application add something like this:

```html
<% if Rails.env == 'test' %>
  <%= javascript_include_tag 'nitrolinks/load-helper' %>
<% end %>
```

## Development

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 tags, 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/asartlo/nitrolinks-rails](https://github.com/asartlo/nitrolinks-rails).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
nitrolinks-rails-0.3.0	README.md