Skip to content

Commit

Permalink
Updated changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shivam091 committed Oct 22, 2023
1 parent 9f98827 commit 88ffdba
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
## [5.3.0](https://github.com/shivam091/unit_measurements/compare/v5.2.0...v5.3.0) - 2023-10-24

### What's new

- Added ability set globally configurable options for **`unit_measurements`**.

### What's improved

- Code coverage improvements.

----------

## [5.2.0](https://github.com/shivam091/unit_measurements/compare/v5.1.1...v5.2.0) - 2023-10-22

### What's new
Expand Down
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ The `unit_measurements` gem is designed to simplify the handling of units for sc

## Features

1. Provides easy conversion between units.
2. Lightweight and easily extensible to include other units and conversions.
3. Built in support for various [unit groups](https://github.com/shivam091/unit_measurements/blob/main/units.md).
1. Simplifies the conversion of measurements between compatible units.
2. Easily add new units and conversions to suit specific needs.
3. Built-in support for various [unit groups](https://github.com/shivam091/unit_measurements/blob/main/units.md).
4. Ability to parse strings representing complex, fractional, mixed fractional, scientific numbers, and ratios.
5. Well organized and descriptive documentation published [here](https://shivam091.github.io/unit_measurements).
6. Supports caching of conversion factors between different units of the unit group.
5. Well-organized and descriptive [documentation](https://shivam091.github.io/unit_measurements).
6. Ability to cache conversion factors for improved performance.
7. Fine-tune behavior using configurable options.

## Disclaimer

Expand Down Expand Up @@ -57,6 +58,23 @@ Or otherwise simply install it yourself as:

`$ gem install unit_measurements`

## Configuration

`unit_measurements` is designed to work out of the box, but you can customize its behavior by placing
the configuration block in an initializer file before requiring the library files:

```ruby
UnitMeasurements.configure do |config|
config.use_cache = false
end
```

The current available configurable options are:

| Option | Default value | Description |
| ------ | ------------- | ----------- |
| **use_cache** | false | Set to `true` to enable caching during conversions. |

## Usage

The **`UnitMeasurements::Measurement`** class is responsible for conversion of quantity to various compatible units
Expand Down

0 comments on commit 88ffdba

Please sign in to comment.