<commit_before># familysearch gem

## Installation

You can install it from the commandline.

    gem install familysearch

Or add it to a Gemfile for use with Bundler

    gem "familysearch", "~> 0.1.0 "


## Basic Usage

Here's how to use it

    require 'rubygems'
    require 'familysearch'
    
    # Instantiate a Client object
    client = FamilySearch::Client.new :environment => :sandbox, :key => 'your-dev-key-here'
    
    # Load the Discovery resource
    client.discover!
    
    # For testing, you can use basic auth to get a session, 
    # Don't do this in your production web app. Use OAuth 2.0
    client.basic_auth! 'api-user-1241', '1782'
    
    me = client.get(client.discovery.links.current_user_person.href).body

More documentation coming soon...

## Copyright

Copyright (c) 2013 <NAME>. See LICENSE.txt for
further details.
<commit_msg>Update the README with an example of how to traverse the response of a get.<commit_after># familysearch gem

## Installation

You can install it from the commandline.

    gem install familysearch

Or add it to a Gemfile for use with Bundler

    gem "familysearch", "~> 0.1.0 "


## Basic Usage

Here's how to use it

    require 'rubygems'
    require 'familysearch'
    
    # Instantiate a Client object
    client = FamilySearch::Client.new :environment => :sandbox, :key => 'your-dev-key-here'
    
    # Load the Discovery resource
    client.discover!
    
    # For testing, you can use basic auth to get a session, 
    # Don't do this in your production web app. Use OAuth 2.0
    client.basic_auth! 'your-username', 'your-password'
    
    me = client.get(client.discovery.links.current_user_person.href).body
    
    # The response object is a Rash object (Hashie extension) which allows you to traverse via dot notation.
    # It also allows an _ to be placed at the end of elements you are traversing to guard against nil values.
    me.persons[0].display_.name

More documentation coming soon...

## Copyright

Copyright (c) 2013 <NAME>. See LICENSE.txt for
further details.

{'fraction_non_alphanumeric': 0.08450704225352113, 'fraction_numerical': 0.013113161728994658, 'mean_word_length': 3.0792079207920793, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1705818', 'n_tokens_mistral': 643, 'n_tokens_neox': 595, 'n_words': 240}