diff --git a/Gemfile.lock b/Gemfile.lock index 53d89af..e9a86b4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,6 @@ PATH remote: . specs: - check_appointments (0.0.1) GEM remote: https://rubygems.org/ @@ -14,3 +13,6 @@ PLATFORMS DEPENDENCIES check_appointments! rake + +BUNDLED WITH + 1.11.2 diff --git a/README.md b/README.md index e69de29..73c9161 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,38 @@ +# The Check Appointments Ruby Gem +A Ruby wrapper for the Check Appointments API + +## Installation +Add it to your Gemfile: + gem 'check_appointments' +Run the following command to install it: + bundle install +Or from the command line, run: + gem install check_appointments + +#Setup & Configuration +1. Make an initializer by creating a file called check_appointments.rb in 'config\initializers' and adding the following to the file: + + + # Added to your config\initializers file + CheckAppointments.configure do |config| + config.api_key = 'YOUR_CHECK_APPOINTMENTS_API_KEY' + config.private_key = 'YOUR_CHECK_APPOINTMENTS_PRIVATE_KEY' + config.base_url = 'https://checkappointments.com/businessWeb' + end + +#Usage Example(s) + #Get all the appointments, this might take a while if you have a lot of them. + CheckAppointments::Appointment.find_all + +#Contribute +Please feel free to help out in any way you can. Make a suggestion, correct a typo, report a bug, etc. + +#Submitting an Issue +We use the GitHub Issue Tracker to track bugs and features. + +#Supported Rubies +* Ruby = 1.8.7 +* Ruby >= 1.9 + +#Todos +* Need to fully implement testing diff --git a/check_appointments-0.0.8.gem b/check_appointments-0.0.8.gem new file mode 100644 index 0000000..1c23355 Binary files /dev/null and b/check_appointments-0.0.8.gem differ diff --git a/check_appointments.gemspec b/check_appointments.gemspec index 708e052..4f4f05d 100644 --- a/check_appointments.gemspec +++ b/check_appointments.gemspec @@ -1,6 +1,6 @@ Gem::Specification.new do |s| s.name = %q{check_appointments} - s.version = "0.0.5" + s.version = "0.0.8" s.date = %q{2015-02-18} s.summary = %q{Gem that interfaces with the CheckAppointments API} s.files = Dir["README.md","Gemfile","Rakefile", "lib/**/*"]