README.md in peak_flow_utils-0.1.10 vs README.md in peak_flow_utils-0.1.11

@@ -1,25 +1,50 @@
-# PeakFlowUtils
-Short description and motivation.
+# PeakflowUtils
 
-## Usage
-How to use my plugin.
+Various tools to use with www.peakflow.io.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'peak_flow_utils'
+gem "peak_flow_utils"
 ```
 
 And then execute:
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
 ```bash
 $ gem install peak_flow_utils
+```
+
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::Notifier.configure(auth_token: "your-token")
+```
+
+## Usage
+
+### Reporting errors manually
+
+```ruby
+PeakFlowUtils::Notifier.notify(error: error)
+```
+
+### Reporting Rails errors
+
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::NotifierRails.configure
+```
+
+### Reporting Sidekiq errors in Rails:
+
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::NotifierSidekiq.configure
 ```
 
 ## Contributing
 Contribution directions go here.