README.rdoc in crunchbase_v2-0.0.1 vs README.rdoc in crunchbase_v2-0.0.2

- old
+ new

@@ -4,21 +4,26 @@ == Installation Add this line to your application's Gemfile: - gem 'crunchbase', github: 'encoreshao/crunchbase_v2' + gem 'crunchbase_v2' And then execute: $ bundle +Or install it yourself as: + + $ gem install crunchbase_v2 + == Usage Examples -Config your user_key, debug somewhere like development.rb. +Config your user_key, debug somewhere like development.rb, Recommended directory config/initializers/crunchbase.rb - Crunchbase::API.key = 'YOUR_API_KEY' + require 'crunchbase_v2' + Crunchbase::API.key = 'user_key' Crunchbase::API.debug = false === Search Searching the Crunchbase is possible with the Search class, The Search will return a list consisting of objects of the SearchResult type. @@ -33,21 +38,19 @@ === Organizations && RelationShip List Items Get information by the permalink, Example: company = Crunchbase::Organization.get("facebook") - Relationship objects - [ competitors customers founders funding_rounds ipos products sub_organizations ] - Friendly relationship objects - [ past_teams current_teams acquisitions offices headquarters categories investments primary_images images websites new_items board_members_and_advisors ] + Relationship objects [ competitors customers founders funding_rounds ipos products sub_organizations ] company.competitors Only return Top 8 items company.competitors_total_items Return competitors total items count company.competitors.each do |e| competitor = a.fetch puts competitor.name end OR + Friendly relationship objects [ past_teams current_teams acquisitions offices headquarters categories investments primary_images images websites new_items board_members_and_advisors ] company.websites If you want all competitors items, Please do: all_competitors = Competitor.lists_for_permalink(company.permalink) @@ -64,14 +67,14 @@ people = Crunchbase::Person.list( page ) people.results - [#<Crunchbase::SearchResult:0x007fd16ae18b40 ...>, + [ #<Crunchbase::SearchResult:0x007fd16ae18b40 ...>, #<Crunchbase::SearchResult:0x007fd16ae18870 ...>, #<Crunchbase::SearchResult:0x007fd16ae185a0 ...>, #<Crunchbase::SearchResult:0x007fd16ae182f8 ...> - ......] + ...... ] === How to use Location & Category .... Such as a Person