README.md in ruby-units-4.0.3 vs README.md in ruby-units-4.1.0
- old
+ new
@@ -294,28 +294,33 @@
Configuration options can be set like:
```ruby
RubyUnits.configure do |config|
+ config.format = :rational
config.separator = false
end
```
-Currently there is only one configuration you can set:
+| Option | Description | Valid Values | Default |
+|-----------|------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------|
+| format | Only used for output formatting. `:rational` is formatted like `3 m/s^2`. `:exponential` is formatted like `3 m*s^-2`. | `:rational, :exponential` | `:rational` |
+| separator | Use a space separator for output. `true` is formatted like `3 m/s`, `false` is like `3m/s`. | `true, false` | `true` |
-1. separator (true/false): should a space be used to separate the scalar from
- the unit part during output.
-
### NOTES
#### Performance vs. Accuracy
Ruby units was originally intended to provide a robust and accurate way to do
arbitrary unit conversions. In some cases, these conversions can result in the
creation and garbage collection of a lot of intermediate objects during
calculations. This in turn can have a negative impact on performance. The design
of ruby-units has emphasized accuracy over speed. YMMV if you are doing a lot of
math involving units.
+
+## Support Policy
+
+Only currently maintained versions of ruby and jruby are supported.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Folbrich%2Fruby-units?ref=badge_large)