Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pavlos committed Apr 10, 2016
1 parent 38c36fc commit 326225b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ __Tachometer polls the schedulers and returns their utilization ratio during the
## Usage

### Obtaining Readings

Tachometer polls the schedulers and returns their utilization ratio during the last poll interval.

`read/0` returns a float between `0` and `1` which represents fractional utilization of all schedulers during the last `poll_interval`.
Expand All @@ -76,7 +77,7 @@ iex(3)> Tachometer.read
0.1250937703951221
```

`below_max?` takes an snapshot of scheduler usage to determine if schedulers have any remaning capacity for work. __It is instantaneous and independent of the `poll_interval` at which `read` operates.__
`below_max?/0` takes an snapshot of scheduler usage to determine if schedulers have any remaning capacity for work. __It is instantaneous and independent of the `poll_interval` at which `read/0` operates.__

```elixir
iex(1)> Tachometer.below_max?
Expand Down

0 comments on commit 326225b

Please sign in to comment.