Skip to content

Commit

Permalink
Boil Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
griffithben committed Oct 3, 2023
1 parent 96fc105 commit 5e254cc
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ pattern of `$rate->get{Unit}Per{Unit}` for the respective units. Example using F

### Flow

This class represent the amount of Volume over a period of Time.
This class represent the amount of Volume flowed over a period of Time.

```php
$flow = new Flow(new Volume(gallon: 5), new Time(hour: 1));
Expand All @@ -165,6 +165,20 @@ $flow->getGallonPerMinute(); // 0.083333333333333

___

### Boil

This class represent the amount of Volume boiled over a period of Time.

```php
$boil = new Boil(new Volume(gallon: 5), new Time(hour: 1));

$boil->getGallonPerHour(); // 5

$boil->getGallonPerMinute(); // 0.083333333333333
```

___

## Calculate

A library of calculations that can be used with various Unitz classes.
Expand Down

0 comments on commit 5e254cc

Please sign in to comment.