README.md in breakout-detection-0.1.1 vs README.md in breakout-detection-0.2.0
- old
+ new
@@ -1,19 +1,19 @@
-# Breakout
+# Breakout Ruby
:fire: [BreakoutDetection](https://github.com/twitter/BreakoutDetection) for Ruby
Learn [how it works](https://blog.twitter.com/engineering/en_us/a/2014/breakout-detection-in-the-wild)
-[](https://github.com/ankane/breakout/actions)
+[](https://github.com/ankane/breakout-ruby/actions)
## Installation
Add this line to your application’s Gemfile:
```ruby
-gem 'breakout-detection'
+gem "breakout-detection"
```
## Getting Started
Detect breakouts in a time series
@@ -63,11 +63,11 @@
## Plotting
Add [Vega](https://github.com/ankane/vega) to your application’s Gemfile:
```ruby
-gem 'vega'
+gem "vega"
```
And use:
```ruby
@@ -82,25 +82,25 @@
- [Leveraging Cloud Data to Mitigate User Experience from ‘Breaking Bad’](https://arxiv.org/abs/1411.7955)
## History
-View the [changelog](https://github.com/ankane/breakout/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/breakout-ruby/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
-- [Report bugs](https://github.com/ankane/breakout/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/breakout/pulls)
+- [Report bugs](https://github.com/ankane/breakout-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/breakout-ruby/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
-git clone https://github.com/ankane/breakout.git
-cd breakout
+git clone https://github.com/ankane/breakout-ruby.git
+cd breakout-ruby
bundle install
bundle exec rake compile
bundle exec rake test
```