diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..83e16f8 --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--color +--require spec_helper diff --git a/README.md b/README.md index d15c468..b17b869 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ A type coercion lib works with [Sorbet](https://sorbet.org)'s static type checker and type definitions; raises an error if the coercion fails. +It provides a simple and generic way of coercing types in a sorbet-typed project. It is particularly useful when we're dealing with external API responses and controller parameters. + ## Installation 1. Follow the steps [here](https://sorbet.org/docs/adopting) to set up the latest version of Sorbet and run `srb tc`. 2. Add `sorbet-coerce` to your Gemfile and install them with `Bundler`. diff --git a/sorbet-coerce.gemspec b/sorbet-coerce.gemspec index 38c253d..3433c76 100644 --- a/sorbet-coerce.gemspec +++ b/sorbet-coerce.gemspec @@ -1,8 +1,8 @@ Gem::Specification.new do |s| s.name = %q{sorbet-coerce} - s.version = "0.0.1" + s.version = "0.1.0" s.date = %q{2019-10-04} - s.summary = %q{Type coercion with Sorbet} + s.summary = %q{A type coercion lib works with Sorbet's static type checker and type definitions; raises an error if the coercion fails.} s.authors = ["Chan Zuckerberg Initiative"] s.email = "opensource@chanzuckerberg.com" s.homepage = "https://github.com/chanzuckerberg/sorbet-coerce"