README.md in proforma-extended-evaluator-1.0.0 vs README.md in proforma-extended-evaluator-1.1.0
- old
+ new
@@ -28,10 +28,16 @@
````
bundle add proforma-extended-evaluator
````
+Note: If you are using bundler for auto-requiring then you need to specify as:
+
+```
+gem 'proforma-extended-evaluator', require: 'proforma/extended_evaluator'
+```
+
## Examples
### Connecting to Proforma Rendering Pipeline
To use this plugin within [Proforma](https://github.com/bluemarblepayroll/proforma):
@@ -114,20 +120,22 @@
### Advanced Formatting (Customization/Options)
Formatter options are biased towards USA localization. You can override any of the options of the Formatter class, here are the options and their defaults:
-Option | Default
----------------- | -------
-currency_code | 'USD'
-currency_round | 2
-currency_symbol | '$'
-date_format | '%m/%d/%Y'
-mask_char | 'X'
-false_value | 'No'
-null_value | 'Unknown'
-true_value | 'Yes'
+Option | Default
+------------------- | -------
+currency_code | 'USD'
+currency_round | 2
+currency_symbol | '$'
+date_format | '%m/%d/%Y'
+decimal_separator | '.'
+mask_char | 'X'
+false_value | 'No'
+null_value | 'Unknown'
+thousands_separator | ','
+true_value | 'Yes'
## Contributing
### Development Environment Configuration
@@ -168,13 +176,10 @@
1. Merge Pull Request into master
2. Update `lib/proforma/extended_evaluator/version.rb` using [semantic versioning](https://semver.org/)
3. Install dependencies: `bundle`
4. Update `CHANGELOG.md` with release notes
5. Commit & push master to remote and ensure CI builds master successfully
-6. Build the project locally: `gem build proforma-extended-evaluator`
-7. Publish package to RubyGems: `gem push proforma-extended-evaluator-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`
+6. 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).
## License
This project is MIT Licensed.