= Phone Number Validator

== About

This app is a US phone number-validating RubyGem.

== Installing

  $ gem install phone_number_validator

=== Install Required Gems/Dependencies

  $ bundle install

== Uninstalling

  $ gem uninstall phone_number_validator

== Testing

  $ rake test

== Usage

=== In command line

  $ phone_number_validator '+1 (949) 355-6244 ext. 198842'
  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
  => true

=== In Ruby code

  require 'phone_number_validator'

  check_phone_number = PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')

  print(check_phone_number)

==== Output

  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
  => true

== Download/Install Ruby and RubyGems (on all OS)

=== Windows

==== Ruby

Download and install the RubyInstaller from {RubyInstaller's website}[https://rubyinstaller.org/].

==== RubyGems

Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].

Then run the following:

  $ cd <path/to/extracted/zip>
  $ ruby setup.rb

=== OSX

==== Ruby

Run the following:

  $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  $ sudo brew install ruby

==== RubyGems

Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].

Then run the following:

  $ cd <path/to/extracted/zip>
  $ ruby setup.rb

=== Linux

==== Ruby

Run the following:

  $ sudo apt install ruby-full

==== RubyGems

Download and extract the zip file from the {RubyGems download page}[https://rubygems.org/pages/download].

Then run the following:

  $ cd <path/to/extracted/zip>
  $ ruby setup.rb