endeavour 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a247511ed96daa25a143673af303f47e6dad0d9
-  data.tar.gz: 7e14681ad51366c31fbef445faa738dccbbf5c4d
+  metadata.gz: 9efb61a646f24ddb802b9fe4b472fee135780745
+  data.tar.gz: 944e69df23747c928288cf0c09d84838b0be2043
 SHA512:
-  metadata.gz: a09dc4bb8a15575009bd387b129cb95ef8fe1cf45e8aa289e33d59392b3c697666edd86e803dd1b52bce93ce6777c4b4a2be64e46f2cb9459ec31bf15f9d2043
-  data.tar.gz: d6e94953bb2b226499fcd415787e08dde684c79a896be482d80b3a6a56524e2fa4adaa74405c5b9845458e5bb90da6132f3b13c3ddd64522262bf256dd03ade5
+  metadata.gz: e8da32b5f6bb5a501524643683808f1fac116bbba09d55fb56a10f9c1a36a250e9caa54bf786624f2badaeea2a472b8ea2885daeafceff67d78ba7493a83d9ca
+  data.tar.gz: 807220a7c68ac07de4b0b47928d02fcf6c79b16dcbe629a10fc84da5ad73df59b9684f189f9b0a0fdc288f6ddf1477efc6f90596963f8f17345051a4ae9dc048

data/README.md

@@ -1,6 +1,29 @@
 # Endeavour
 
-[Try](http://api.rubyonrails.org/classes/Object.html#method-i-try), but better.
+Endeavour is a simple gem that adds a `try` method to `Object` and `NilClass`
+instances. `try` permits calling a method on an object and returning `nil`
+rather than `NoMethodError` if the object is `nil` or does not respond to
+the method.
+
+## Usage
+
+There are two ways to use `try`:
+
+### 1. Call-based syntax (similar to Rails' [Object#try](http://api.rubyonrails.org/classes/Object.html#method-i-try))
+
+```ruby
+car.try(:drive)
+
+colors.try(:[], :red)
+```
+
+### 1. Delegate syntax (inspired by [HoboSupport](http://www.hobocentral.net/manual/hobo_support))
+
+```ruby
+car.try.drive
+
+colors.try[:red]
+```
 
 ## Installation
 
@@ -18,12 +41,20 @@ Or install it yourself as:
 
     $ gem install endeavour
 
-## Usage
+### Rails applications
 
-```ruby
-car = nil
-car.try.drive # => nil
-```
+Endeavour uses a
+[Railtie](http://api.rubyonrails.org/classes/Rails/Railtie.html) and can be
+used after initialization without additional configuration.
+
+### Non-Rails applications
+
+Call `Endeavour.hook!` early in your application.
+
+### Remove Endeavour
+
+In some cases, you may want to remove Endeavour (say, if a naughty gem requires
+it).  You can do so with `Endeavour.remove_hook!`
 
 ## Contributing
 

data/lib/endeavour/version.rb

@@ -1,3 +1,3 @@
 class Endeavour
-  VERSION = '0.0.4'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endeavour
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Cory Kaufman-Schofield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters