Add changelog

Author: laurynas

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [2.0.0]
+
+### Added
+- `detect_batch` method for batch detections
+
+### Changed
+- Switched to v3 API which uses updated language detection model
+- ⚠️ `simple_detect` method renamed to `detect_code`
+- ⚠️ `detect` method result fields are `language` and `score`
+- ⚠️ `detect` method no longer accept arrays - use `detect_batch` instead
+- ⚠️ `user_status` method renamed to `account_status`
+- ⚠️ Proxy URL configured using `config.proxy`
+- HTTPS is used by default. Removed secure_mode configuration
+- Client connection is reused. If you change configuration after client is initialized, you need to reset client using `DetectLanguage.client = nil`.

README.md

@@ -6,6 +6,7 @@ Detect Language API Ruby Client
 
 Detects language of the given text. Returns detected language codes and scores.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,6 +15,10 @@ Add this line to your application's Gemfile:
 gem 'detect_language'
 ```
 
+### Upgrading
+
+When upgrading please check [changelog](CHANGELOG.md) for breaking changes.
+
 ### Configuration
 
 Get your personal API key by signing up at https://detectlanguage.com
@@ -35,7 +40,7 @@ DetectLanguage.detect("Buenos dias señor")
 #### Result
 
 ```ruby
-[{"language"=>"es", "isReliable"=>true, "confidence"=>6.62}]
+[{"language"=>"es", "score"=>0.95}]
 ```
 
 ### Language code detection
@@ -67,8 +72,8 @@ DetectLanguage.detect_batch(["Buenos dias señor", "Labas rytas"])
 Result is array of detections in the same order as the texts were passed.
 
 ```ruby
-[ [{"language"=>"es", "isReliable"=>true, "confidence"=>6.62}], 
-  [{"language"=>"lt", "isReliable"=>true, "confidence"=>6.82}] ]
+[ [{"language"=>"es", "score"=>0.95}], 
+  [{"language"=>"lt", "score"=>0.98}] ]
 ```
 
 ### Getting your account status