README.md in breakout-detection-0.1.0 vs README.md in breakout-detection-0.1.1
- old
+ new
@@ -1,10 +1,10 @@
# Breakout
:fire: [BreakoutDetection](https://github.com/twitter/BreakoutDetection) for Ruby
-Learn more about [how it works](https://blog.twitter.com/engineering/en_us/a/2014/breakout-detection-in-the-wild)
+Learn [how it works](https://blog.twitter.com/engineering/en_us/a/2014/breakout-detection-in-the-wild)
[![Build Status](https://github.com/ankane/breakout/workflows/build/badge.svg?branch=master)](https://github.com/ankane/breakout/actions)
## Installation
@@ -56,9 +56,23 @@
beta: 0.008, # penalization term (multi only)
percent: nil, # minimum percent change in goodness of fit statistic (multi only)
alpha: 2, # weight of the distance between observations (amoc only)
exact: true # exact or approximate median (amoc only)
)
+```
+
+## Plotting
+
+Add [Vega](https://github.com/ankane/vega) to your application’s Gemfile:
+
+```ruby
+gem 'vega'
+```
+
+And use:
+
+```ruby
+Breakout.plot(series, breakouts)
```
## Credits
This library uses the C++ code from the [BreakoutDetection](https://github.com/twitter/BreakoutDetection) R package and is available under the same license.