Contents

# Bookends
Shared footer (and eventually header) for Heroku properties.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'bookends'
```

And then execute:

    $ bundle

## Usage

* `rails g bookends:install`
* add `@import 'bookends/footer';` to your application.css.scss
* add `<%= render 'bookends/footer' %>` to your layout where you want the footer.

## Development

### Spin up
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake rspec` to run the tests.

### Install and release
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).

See all rake tasks with `rake -T`

### Working on the gem
```
$ cd spec/dummy
$ rails s
$ open http://localhost:3000
```
From there you can edit the files in
`lib/generators/bookends/install/templates`. Note that images will have to be
copied over to the dummy app in `/spec`. Also note
`spec/dummy/config/application.rb` adds directories from lib into the dummy
app's load path. Add more directories as needed.

### Testing it in an app locally
1. `gem 'bookends', path: 'path/to/local/copy` in the other application's Gemfile
2. `bundle install` from the other application
3. `rails g bookends:install` from the other application
4. boot up the other application
5. If you make changes to bookends, make sure to run the installer from step 3.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/bookends.

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
bookends-0.5.2	README.md
bookends-0.5.1	README.md
bookends-0.5.0	README.md