README.md in ireporter-0.1.0 vs README.md in ireporter-0.1.1
- old
+ new
@@ -1,11 +1,13 @@
# Ireporter
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ireporter`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is the Ruby alternative to **iTunes Connect Reporter** written in java library used to fetch sales and finance reports.
-TODO: Delete this and the text above, and describe your gem
+This gem is written considering requirement of Rails app, but can be used as a regular ruby gem.
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,22 +22,69 @@
$ gem install ireporter
## Usage
-TODO: Write usage instructions here
+Create a reporter object
-## Development
+```
+reporterObj= Ireporter::Reporter.new('user id','password')
+```
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+And use below awesome methods, and see the Magic happen.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Get the status of services (Sales and Finance)
+```
+reporterObj.get_status('Sales')
+reporterObj.get_status('Finance')
+
+```
+
+Fetch the sales report
+
+```
+report_data=reporterObj.get_sales_report('daily','20160818')
+```
+
+And then wrap it in the Array
+
+```
+array = reporterObj.wrap(report_data)
+```
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ireporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nakshay/ireporter.
-## License
+## Contributors
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Akshay Naik
+
+Rushikesh Kawadkar
+
+
+## Contributors
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Akshay Naik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.