Skip to content

Commit

Permalink
more readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
omkarmoghe committed Mar 24, 2024
1 parent 86dae76 commit de75b70
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ If bundler is not being used to manage dependencies, install the gem by executin

## Usage

> [!IMPORTANT]
> When using the gem, all references to the models below must be prefixed with `Expressive::`. This is omitted in the README for simplicity.
### Scalar

A `Scalar` is the simplest object that can be evaluated. It holds a single `value`. When used in an `Expression`, this `value` must respond to the symbol (i.e. support the method) defined by the `Expression#operator`.
Expand Down Expand Up @@ -129,7 +132,7 @@ json_string = <<~JSON
}
JSON
variable_score_a = Expressive.from_json(json_string)
#=> <Variable...>
Environment.new("score_a" => 100).evaluate(variable_score_a) #=> 100
```

### Beyond math
Expand Down

0 comments on commit de75b70

Please sign in to comment.