Updates docs and description

DavyJonesLocker · Aug 23, 2013 · 42dc442 · 42dc442
1 parent 59a63c3
commit 42dc442
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 240 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # PostgresExt
 
-Adds support for missing PostgreSQL data types to ActiveRecord.
+Provides a helpful querying API for Rails 4 + PostgreSQL
 
 [![Build Status](https://secure.travis-ci.org/dockyard/postgres_ext.png?branch=master)](http://travis-ci.org/dockyard/postgres_ext)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/postgres_ext)
@@ -36,54 +36,7 @@ Or install it yourself as:
 Just `require 'postgres_ext'` and use ActiveRecord as you normally would! postgres\_ext extends
 ActiveRecord's data type handling.
 
- * [Migration/Schema.rb support](docs/migrations.md)
- * [Type Casting support](docs/type_casting.md)
  * [Querying PostgreSQL datatypes](docs/querying.md)
- * [Indexes](docs/indexes.md)
-
-## Usage Notes
-Avoid the use of in place operators (ie `Array#<<`). These changes are
-*not* tracked by Rails ([this issue](https://github.com/rails/rails/issues/6954))
-explains why). In place modifications also modify the default object.
-
-Assuming we have the following model:
-
-```ruby
-create_table :items do |t|
-  t.string :names, :array => true, :default => []
-end
-
-class Item < ActiveRecord::Base
-end
-```
-
-The following will modify the default value of the names attribute.
-
-```ruby
-a = Item.new
-a.names << 'foo'
-
-b = Item.new
-puts b.names
-# => ['foo']
-```
-
-The supported way of modifying `a.names`:
-
-```ruby
-a = Item.new
-a.names += ['foo']
-
-b = Item.new
-puts b.names
-# => []
-```
-
-As a result, in place operators are discouraged and will not be
-supported in postgres\_ext at this time. 
-
-
-
 
 ## Authors
 

diff --git a/docs/indexes.md b/docs/indexes.md
diff --git a/docs/migrations.md b/docs/migrations.md
diff --git a/docs/type_casting.md b/docs/type_casting.md
diff --git a/postgres_ext.gemspec b/postgres_ext.gemspec
@@ -4,8 +4,8 @@ require File.expand_path('../lib/postgres_ext/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Dan McClain"]
   gem.email         = ["[email protected]"]
-  gem.description   = %q{Adds missing native PostgreSQL data types to ActiveRecord}
-  gem.summary       = %q{Extends ActiveRecord to handle native PostgreSQL data types}
+  gem.description   = %q{Provides a helpful querying API for Rails 4 + PostgreSQL}
+  gem.summary       = %q{Provides a helpful querying API for Rails 4 + PostgreSQL}
   gem.homepage      = ""
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }