README.md in sumologic-0.0.1 vs README.md in sumologic-0.0.2

- old
+ new

@@ -1,22 +1,45 @@ Sumo Logic Ruby SDK =================== +[![Gem Version](https://badge.fury.io/rb/sumologic.svg)](http://badge.fury.io/rb/sumologic) [![Build Status](https://img.shields.io/travis/grokify/sumologic-sdk-ruby/master.svg)](https://travis-ci.org/grokify/sumologic-sdk-ruby) [![Code Climate](https://codeclimate.com/github/grokify/sumologic-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/grokify/sumologic-sdk-ruby) +[![Docs](https://img.shields.io/badge/docs-rubydoc-blue.svg)](http://www.rubydoc.info/gems/sumologic/) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/grokify/sumologic-sdk-ruby/master/LICENSE.txt) Ruby interface to the Sumo Logic REST API. -Please add your scripts and programs to the `scripts` folder. - ## Usage -The interface for this SDK is still being built out but follows the structure in the +The interface for this SDK is still being built out to follow the structure in the [Sumo Logic Python SDK](https://github.com/SumoLogic/sumologic-python-sdk). -Exampe scripts are located in the `scripts` director of the GitHub repo. +The following methods are currently implemented: +* `search(query [, from, to, time_zone])` +* `search_job(query [, from, to, time_zone])` +* `search_job_records({'id' => search_job_id}, limit, offset)` +* `search_job_status( {'id' => search_job_id})` + +Note, for the search methods, the query parameter can be exactly the same query that is entered into the Sumo Logic web console. + +Example scripts are located in the `scripts` directory of the [GitHub repo](https://github.com/grokify/sumologic-sdk-ruby). + ## More Info 1. [Sumo Logic API Documentation](https://github.com/SumoLogic/sumo-api-doc/wiki) -2. [Sumo Logic Python SDK](https://github.com/SumoLogic/sumologic-python-sdk) +2. [Sumo Logic Python SDK](https://github.com/SumoLogic/sumologic-python-sdk) + +## Contributions + +Please add your scripts and programs to the `scripts` folder. + +Any reports of problems, comments or suggestions are most welcome. + +Please report these on [Github](https://github.com/grokify/sumologic-sdk-ruby) + +## License + +RingCentral SDK is available under an MIT-style license. See {file:LICENSE.txt} for details. + +RingCentral SDK © 2015 by John Wang \ No newline at end of file