Skip to content

Commit

Permalink
fix merge
Browse files Browse the repository at this point in the history
  • Loading branch information
James McKinney committed Oct 5, 2014
2 parents 032c977 + 08770f2 commit dc9ce24
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,23 @@ Until [Faraday Middleware](https://github.com/lostisland/faraday_middleware) rel
gem 'faraday_middleware', git: 'https://github.com/lostisland/faraday_middleware.git'
```

## Performance

Pupa.rb offers several ways to significantly improve performance. [Read the documentation.](https://github.com/opennorth/pupa-ruby/blob/master/PERFORMANCE.md#readme)

## Integration with ODMs

`Pupa::Model` is incompatible with `Mongoid::Document`. **Don't do this**:

```ruby
class Cat
include Pupa::Model
include Mongoid::Document
end
```

Instead, have a simple scraping model that includes `Pupa::Model` and an app model that includes `Mongoid::Document` with your app's business logic.

## What it tries to solve

Pupa.rb's goal is to make scraping less painful by solving common problems:
Expand Down Expand Up @@ -90,23 +107,6 @@ require 'pupa/refinements/opencivicdata'

It is not currently possible to run the `scrape` action with one of Pupa.rb and Pupa, and to then run the `import` action with the other. Both actions must be run by the same library.

## Integration with ODMs

`Pupa::Model` is incompatible with `Mongoid::Document`. Don't do this:

```ruby
class Cat
include Pupa::Model
include Mongoid::Document
end
```

Instead, have a scraping model that includes `Pupa::Model` and an app model that includes `Mongoid::Document`.

## Performance

Pupa.rb offers several ways to significantly improve performance. [Read the documentation.](https://github.com/opennorth/pupa-ruby/blob/master/PERFORMANCE.md#readme)

## Testing

**DO NOT** run this gem's specs if you are using Redis database number 15 on `localhost`!
Expand Down

0 comments on commit dc9ce24

Please sign in to comment.