Add changelog

Author: laurynas

CHANGELOG.md

@@ -0,0 +1,19 @@
+# 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).
+
+
+## v3.0.0
+
+### Added
+- `detectBatch` method for batch detections
+
+### Changed
+- Switched to v3 API which uses updated language detection model
+- ⚠️ `simpleDetect` method renamed to `detectCode`
+- ⚠️ `detect` method result fields are `language` and `score`
+- ⚠️ `detect` method no longer accept arrays - use `detectBatch` instead
+- HTTPS is used by default. Removed secure mode configuration.

README.md

@@ -28,6 +28,10 @@ Create or add the following to composer.json in your project root:
 }
 ```
 
+## Upgrading
+
+When upgrading please check [changelog](CHANGELOG.md) for breaking changes.
+
 ## Usage
 
 ### Configuration

lib/DetectLanguage/DetectLanguage.php

@@ -58,6 +58,10 @@ public static function setApiKey($apiKey)
      */
     public static function detect($text)
     {
+        if (is_array($text)) {
+            throw new Error('detect method does not accept arrays, use detectBatch instead');
+        }
+
         return Client::request('POST', 'detect', array('q' => $text));
     }
 

tests/DetectLanguage/DetectLanguageTest.php

@@ -23,7 +23,7 @@ public function testConstructor()
             'Expect the API key to be set.');
     }
 
-    public function testDetection()
+    public function testDetect()
     {
         $result = DetectLanguage::detect('Hello world');
 
@@ -36,6 +36,12 @@ public function testDetection()
             'To detect Lithuanian language.');
     }
 
+    public function testDetectWithArray()
+    {
+        $this->expectException('\DetectLanguage\Error');
+        $result = DetectLanguage::detect(array('Hello world'));
+    }
+
     public function testDetectCode()
     {
         $result = DetectLanguage::detectCode('Hello world');