README.md in splunk-client-0.8.0 vs README.md in splunk-client-0.8.1

- old
+ new

@@ -41,11 +41,11 @@ # Create the client splunk = SplunkClient.new("username", "password", "hostname") # Fetch all the open alerts - alertEntries = splunk.get_alarm_list.entries + alertEntries = splunk.get_alert_list.entries # What's the name of this alert? alertEntries[1].alert.title # What time did a particular alert trigger? @@ -69,9 +69,31 @@ * Access Splunk fields in results via simple method calls `result = search.parsedResults` `puts result[0].fieldName` +## FAQ + +#### What is Splunk? + +I'm making an assumption that if you are looking for a Ruby client to interact with Splunk's REST API, you have some idea of what Splunk does. If not, you should totally check it out. It makes working with logs awesome. + +http://www.splunk.com + +#### Where can I find information on Splunk's REST API and the methods available in this gem? + +The Splunk REST API reference can be found here: +http://docs.splunk.com/Documentation/Splunk/5.0.1/RESTAPI/RESTsearch + +This gem currently only provides access to the /search/ and /alerts/ APIs. The gem attempts to make use of `method_missing` to implement ruby methods where fields are returned from a given Splunk search. + +#### Why do I get an exception when using `wait` on a search? + +Very little excetption handling occurs with-in the gem. It is up to consumers to ensure they have appropriate network connectivity to their splunk endpoint, and that the credentials are correct. + +Insufficient network connectivity will raise a `TimeOut` exception. + +Incorrect credentials will raise a Nokogiri error referencing `Undefined namespace prefix: //s:key[@name='isDone']` ## Revision History #### 0.8 \ No newline at end of file