README.md in trend-0.1.1 vs README.md in trend-0.1.2

- old
+ new

@@ -2,19 +2,19 @@ Ruby client for [Trend](https://trendapi.org), the anomaly detection and forecasting API [![Build Status](https://travis-ci.org/ankane/trend.svg?branch=master)](https://travis-ci.org/ankane/trend) -## Getting Started +## Installation Add this line to your application’s Gemfile: ```ruby gem 'trend' ``` -### Anomaly Detection +## Anomaly Detection Detect anomalies in a time series ```ruby # generate series @@ -36,11 +36,11 @@ ```ruby series = User.group_by_day(:created_at).count Trend.anomalies(series) ``` -### Forecasting +## Forecasting Get future predictions for a time series ```ruby series = {} @@ -64,20 +64,20 @@ ```ruby Trend.forecast(series, count: 3) ``` -### Correlation [experimental] +## Correlation [experimental] Get the correlation between two time series ```ruby Trend.correlation(series, series2) ``` ## Authentication -An API key is needed for more than 1000 requests per day per IP. [Email us](mailto:hi@trendapi.org) to get one. +An API key is needed for more than 1,000 requests per day per IP. [Email us](mailto:hi@trendapi.org) to get one. If you have one, set `ENV["TREND_API_KEY"]` or use: ```ruby Trend.api_key = "secret"