README.md in is_ok-0.0.1 vs README.md in is_ok-1.1.0
- old
+ new
@@ -1,17 +1,15 @@
-# Ok
+# IsOK
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ok`. To experiment with that code, run `bin/console` for an interactive prompt.
+A library for making it easier to use ok/error responses in Ruby case statements. Written by someone who missed case statements with pattern matching in Elixir :)
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'ok'
+gem 'is_ok'
```
And then execute:
$ bundle
@@ -20,20 +18,24 @@
$ gem install ok
## Usage
-TODO: Write usage instructions here
+For usage instructions, see [these tests](test/is_ok_test.rb)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ok. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/amorphid/is_ok_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Code of Conduct
-Everyone interacting in the Ok project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ok/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ok project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+[Apache 2.0](LICENSE.md)