README.md in peterosullivan-highrise-3.0.2 vs README.md in peterosullivan-highrise-3.0.3
- old
+ new
@@ -1,18 +1,28 @@
-##whats in this fork
+##Whats in this fork
This fork is very close to the orginal gem. I have added a few features and shortcut methods;
Highrise::Tag.delete_by_name('tag_name')
Highrise::Person.url_for(123)
Highrise::Person.find(123).tagged?('tag_name')
+ Highrise::Person.find(123).tagged_with_name('tag_name')
Highrise::Person.find(123).email_address
Highrise::Person.find(123).email_valid?
Highrise::Person.find(123).phone_number
+
+###Highrise Custom Fields read only (called "subject_datas" in the Highrise API)
+ p = Highrise::Person.find(123)
+ p.subject_data_fields #{"favourite_color"=>"red"}
+ p.field("FavouriteColor") #<Highrise::SubjectData:0xb5e3442c @attributes={"subject_field_label"=>"FavouriteColor", "id"=>12065552, "value"=>"red", "subject_field_id"=>123}, @prefix_options={}>
+ p.favourite_color #"red"
+
+
+
# Highrise (3.0.0) [![Build Status](https://secure.travis-ci.org/tapajos/highrise.png)](http://travis-ci.org/tapajos/highrise)
## What is it?
This gem provides a set of classes to access information on [Highrise][h] via the published [API][api]:
@@ -22,9 +32,12 @@
All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveResouce][ar] documentation for more information.
## Installing
gem install peterosullivan-highrise
+
+## Gemfile
+ gem 'peterosullivan-highrise', :require => 'highrise'
### Dependencies (see <code>highrise.gemspec</code> or run <code>bundle check</code>)
### Documentation