Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add basic usage instructions to README.

  • Loading branch information...
commit 0d53df42ac52454efab626ab9ad9155086d1524f 1 parent 9385b53
@tristandunn authored
Showing with 16 additions and 0 deletions.
  1. +16 −0 README.markdown
View
16 README.markdown
@@ -2,6 +2,22 @@
A fake [Pusher](http://pusher.com) server for development and testing.
+## Usage
+
+#### 1. Use the PusherFake server host and port for the Pusher JS client.
+
+```erb
+<script>
+ <%== PusherFake.javascript if defined?(PusherFake) %>
+</script>
+```
+
+#### 2. Start PusherFake in Cucumber environment. If you aren't using Cucumber, see [pusher-fake/cucumber.rb](https://github.com/tristandunn/pusher-fake/blob/master/lib/pusher-fake/cucumber.rb).
+
+```ruby
+require "pusher-fake/cucumber"
+```
+
## Examples
* [pusher-fake-example](https://github.com/tristandunn/pusher-fake-example) - An example of using pusher-fake with Cucumber to test a Rails application.
Please sign in to comment.
Something went wrong with that request. Please try again.