# Glimpse

[![Build Status](https://travis-ci.org/dewski/glimpse.png?branch=master)](https://travis-ci.org/dewski/glimpse)

Provide a glimpse into your Rails applications.

## Installation

Add this line to your application's Gemfile:

    gem 'glimpse'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install glimpse

## Usage

```ruby
Glimpse.view Glimpse::Git, :github => 'github/hire'
Glimpse.view Glimpse::NavigationTime
Glimpse.view Glimpse::Unicorn
Glimpse.view Glimpse::ActiveRecord
Glimpse.view Glimpse::Redis
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

# Glimpse

[![Build Status](https://travis-ci.org/dewski/glimpse.png?branch=master)](https://travis-ci.org/dewski/glimpse)

Provide a glimpse into your Rails applications.

## Installation

Add this line to your application's Gemfile:

    gem 'glimpse'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install glimpse

## Usage

Run the Rails generator to get Glimpse up and included into your project:

```
rails generate glimpse:install
```

This will create a file at `config/initializers/glimpse.rb` which will give you
example views to include into your Glimpse bar.

Feel free to pick and choose from the list or create your own. The order they
are added to Glimpse, the order they will appear in your bar.

```ruby
Glimpse.view Glimpse::Views::Git, :github => 'github/hire'
Glimpse.view Glimpse::Views::NavigationTime
Glimpse.view Glimpse::Views::Unicorn
Glimpse.view Glimpse::Views::ActiveRecord
Glimpse.view Glimpse::Views::Redis
```

Once your views are added to Glimpse, just render your bar by adding the following
after the opening `<body>` tag in your application layout.

```ruby
<%= render 'glimpse/bar' %>
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Update usage bit in docs
Update usage bit in docs
