README.markdown in couchpillow-0.1 vs README.markdown in couchpillow-0.1.1
- old
+ new
@@ -17,15 +17,20 @@
- Automatic timestamp
- Validation
+## Installation
+
+ gem install couchpillow
+
+
## How To Use
- CouchPillow.db = Couchbase.connect(
- bucket: 'default',
- host: 'localhost' )
+ require 'couchpillow'
+
+ CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
doc = CouchPillow::Document.new( { :stuff => 'hello' }, '123' )
doc.save!
# {
# '_type': 'default',
@@ -45,13 +50,11 @@
class User < CouchPillow::Document
type :user
end
- CouchPillow.db = Couchbase.connect(
- bucket: 'default',
- host: 'localhost' )
+ CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
doc = User.new( { :email => 'john@email.com' } )
doc.email # 'john@email.com'
doc.save!
# {
@@ -67,15 +70,13 @@
class User < CouchPillow::Document
type :user
validate_presence :email
end
- CouchPillow.db = Couchbase.connect(
- bucket: 'default',
- host: 'localhost' )
+ CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
doc = User.new( { :first_name => 'John' } )
- doc.save! # raises ValidationError('email is missing')
+ doc.save! # raises ValidationError('email is missing')
doc.email = 'john@email.com'
doc.save! # Success!
Using custom validation blocks
@@ -83,12 +84,10 @@
type :user
validate_presence :email
validate :phone, 'is not a number', lambda { |v| v.is_a? Numeric }
end
- CouchPillow.db = Couchbase.connect(
- bucket: 'default',
- host: 'localhost' )
+ CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
doc = User.new
doc.email = 'john@email.com'
doc.first_name = 'john'
doc.phone = '123'
doc.save! # raises ValidationError('phone is not a number')