Skip to content

Commit

Permalink
Installation
Browse files Browse the repository at this point in the history
  • Loading branch information
ismasan committed Jul 18, 2024
1 parent 6075eb5 commit a80ca4e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ For a description of the core architecture you can read [this article](https://i

## Installation

TODO
Install in your environment with `gem install plumb`, or in your `Gemfile` with

```ruby
gem 'plumb'
```

## Usage

### Include base types
### Include base types.

Include base types in your own namespace:

Expand All @@ -39,6 +43,8 @@ result.valid? # false
result.errors # ""
```

Note that this is not mandatory. You can also work with the `Plumb::Types` module directly, ex. `Plumb::Types::String`

### Specialize your types with `#[]`

Use `#[]` to make your types match a class.
Expand Down

0 comments on commit a80ca4e

Please sign in to comment.