Contents

# SeoFriendly

SeoFriendly gem provides easy way to insert meta information (title, description, keywords) on almost all pages of your application.
Gem extract meta information for model from it's fields or from any source you specify.

## Installation

```ruby
gem 'seo_friendly'
```

For fast gem integration run generator that copy migration files and default source config into your application.
Gem use monkey patching to add new methods to ActiveRecord and new view helpers.

    $ rails generate seo_friendly:install

## Usage

Create your own seo source class for any model and specify information which will be used to create meta tags.
Example:
```ruby
# seo source class for Page model
class PageSeoSource < DefaultSeoSource

  # title information will be extracted from title field of Page instance
  def title
    instance.title
  end

  # description will be always constant for Page
  def description
    'Awesome pages of my beautiful application'
  end

  # Page model can have for example tags reference that you can use to generate keywords.
  def keywords
    instance.tags.join(' ,')
  end

end
```

## Views
On views you can insert meta tags using helper

```haml
  = meta_tags(@page) %>
```

## Model
To update meta information every time when you update records add to model callback:
```ruby
  after_save :update_seo_attributes
```

## Rake
If you change model source and want to update seo information for all instances of this model you can use rake task

    $ rake seo_friendly:regenerate[ModelName]

## TODO
 2) Add tests
 6) WordsSplitter is too slow, replace it with regular expression (change)


1. Fork it ( https://github.com/rossmari/seo_friendly/fork )
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 a new Pull Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
seo_friendly-0.0.2	README.md
seo_friendly-0.0.1	README.md