README.md in differential-1.0.2 vs README.md in differential-1.0.3

- old
+ new

@@ -108,11 +108,11 @@ ``` To run the report, run: ``` -report = Differential.calculate(week1_data, week2_data, reader_config) +report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config) ``` The report variable will now hold a Report object with the following methods: * a_sigma: sum of all A record values @@ -147,11 +147,11 @@ ``` Then execute: ``` -report = Differential.calculate(week1_data, week2_data, reader_config) +report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config) ``` ### By Employee, Grouped By Transport Type Report Change the options like so: @@ -165,11 +165,11 @@ ``` Then execute: ``` -report = Differential.calculate(week1_data, week2_data, reader_config) +report = Differential.calculate(dataset_a: week1_data, dataset_b: week2_data, reader_config: reader_config) ``` Now, this will output a report with two groups instead of one which will allow you to present this with sub-totals. ### Compound ID Keys @@ -215,9 +215,25 @@ Also, do not forget to run Rubocop: ```` bundle exec rubocop ```` + +### Publishing + +Note: ensure you have proper authorization before trying to publish new versions. + +After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions: + +1. Merge Pull Request into master +2. Update [lib/differential/version.rb](https://github.com/bluemarblepayroll/differential/blob/master/lib/differential/version.rb) [version number](https://semver.org/) +3. Bundle +4. Update CHANGELOG.md +5. Commit & Push master to remote and ensure CI builds master successfully +6. Build the project locally: `gem build differential` +7. Publish package to NPM: `gem push differential-X.gem` where X is the version to push +8. Tag master with new version: `git tag <version>` +9. Push tags remotely: `git push origin --tags` ## License This project is MIT Licensed.