lib/citrulu.rb in citrulu-0.1.0 vs lib/citrulu.rb in citrulu-0.1.1

@@ -1,12 +1,13 @@
 Dir[File.expand_path('../citrulu/*.rb', __FILE__)].each{|f| require f}
 Dir[File.expand_path('../faraday/*.rb', __FILE__)].each{|f| require f}
 require 'faraday'
 
 module Citrulu
+  # The address of the Citrulu API
   BASE_URL = "https://www.citrulu.com/api/v1"
-  # BASE_URL = "http://localhost:3000/api/v1"
   
+  # Sets up the connection to the Citrulu API using the api key, which must already have been set to CITRULU_API_KEY
   def self.connection
     Faraday.new(:url => BASE_URL) do |connection|
       connection.request  :url_encoded             # form-encode POST params
       connection.response :logger                  # log requests to STDOUT
       connection.adapter  Faraday.default_adapter  # make requests with Net::HTTP
\ No newline at end of file