From 08770f21f1fb357d433b3e483dddd73125ae1a83 Mon Sep 17 00:00:00 2001 From: James McKinney Date: Sat, 4 Oct 2014 23:47:10 -0400 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e755976..504a7ea 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,23 @@ The [organization.rb](http://opennorth.github.io/pupa-ruby/docs/organization.htm JSON parsing is enabled by default. To enable automatic parsing of HTML and XML, require the `nokogiri` and `multi_xml` gems. +## 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: @@ -82,23 +99,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`!