Bump version to 0.2.0 and include supported matchers in README

bittrance · Jan 16, 2017 · 007404f · 007404f
1 parent 22527a7
commit 007404f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rx-rspec (0.1.3)
+    rx-rspec (0.2.0)
       rx
 
 GEM

diff --git a/README.md b/README.md
@@ -28,7 +28,15 @@ require 'rx'
 require 'rx-rspec'
 
 describe 'awesome' do
-  subject { Rx::Observable.just(42) }
-  it { should emit_exactly(42) }
+  subject { Rx::Observable.of(1, 2, 3) }
+  it { should emit_exactly(1, 2, 3) }
 end
 ```
+
+## Matchers
+
+rx-spec include the following matchers:
+
+- **emit_exactly()** metches against all items produced by the observable and requires the observable to be completed.
+- **emit_first()** matches against the first elements of the observable, but does not require it to complete
+- **emit_include()** consumes elements until the expected elements have occurred
diff --git a/rx-rspec.gemspec b/rx-rspec.gemspec
@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'rx-rspec'
-  spec.version     = '0.1.3'
+  spec.version     = '0.2.0'
   spec.summary     = 'rspec testing support for RxRuby'
   spec.description = 'Writing specs for reactive streams is tricky both because of their asynchronous nature and because their next/error/completed semantics. The goal of rx-rspec is to provide powerful matchers that lets you express your expectations in a traditional rspec-like synchronous manner.'
   spec.authors     = ['Anders Qvist']