diff --git a/README.md b/README.md index 2d862e4..d853f11 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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.