README.md in ireporter-0.1.1 vs README.md in ireporter-0.1.2
- old
+ new
@@ -1,19 +1,24 @@
-# Ireporter
+# Ireporter ![](http://ruby-gem-downloads-badge.herokuapp.com/ireporter?type=total)
-This gem is the Ruby alternative to **iTunes Connect Reporter** written in java library used to fetch sales and finance reports.
+Ireporter is an Ruby alternative to **iTunes Connect Reporter** a java library provided by Apple, which is used to fetch sales and finance reports.
+Ireporter takes username and password for iTunes Connector and makes JSON request to get the response from ITC, unlike Apple's Reporter Ireporter removes the overhead of unzipping the archive file to get the data form text file, instead it gives the data in string data type, which can be wrapped into Array of hashses using Ireporter's wrap method. Later on can be converted in to JSON and other formats using ruby methods for conversion as per convenience.
This gem is written considering requirement of Rails app, but can be used as a regular ruby gem.
+Currently Ireporter allows to fetch the status of Sales and Finance reports, fetch the vendor number and extracts the sales reports.
+We are still working on extracting Financial report feature and will be added in next release.
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'ireporter'
+gem 'ireporter', '~> 0.1.2'
```
And then execute:
$ bundle
@@ -25,11 +30,16 @@
## Usage
Create a reporter object
```
-reporterObj= Ireporter::Reporter.new('user id','password')
+require 'ireporter'
+
+include Ireporter
+
+reporterObj= Reporter.new('user id','password')
+
```
And use below awesome methods, and see the Magic happen.
Get the status of services (Sales and Finance)
@@ -41,31 +51,42 @@
```
Fetch the sales report
```
-report_data=reporterObj.get_sales_report('daily','20160818')
+report_data=reporterObj.get_sales_report(Reporter::DATE_TYPE_DAILY,'20160818')
```
+Date types
+
+```
+DATE_TYPE_DAILY (YYYYMMDD)
+DATE_TYPE_WEEKLY (YYYYMMDD) => DD should be Sunday of the Week
+DATE_TYPE_MONTHLY (YYYYMM)
+DATE_TYPE_YEARLY (YYYY)
+
+```
+
And then wrap it in the Array
```
array = reporterObj.wrap(report_data)
```
## Contributing
+You can help us to make the iReporter better.
Bug reports and pull requests are welcome on GitHub at https://github.com/nakshay/ireporter.
-## Contributors
+## Maintained by.
-Akshay Naik
+**Akshay Naik**
-Rushikesh Kawadkar
+**Rushikesh Kawadkar**
-## Contributors
+## License
The MIT License (MIT)
Copyright (c) 2017 Akshay Naik