Merge pull request #20 from minibikini/release-0.5.0

Release 0.5.0

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [Unreleased]
+
+## 0.5.0 - 2019-10-31
+
+### Added
+
+- A script to update language data
+
+### Changed
+
+- Update language data

README.md

@@ -7,15 +7,15 @@
 
 Natural language detection for Elixir
 
-[Api Documentation] | [Hex Package]
+[API Documentation] | [Hex Package]
 
 ## Installation
 
 Add `paasaa` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
-  [{:paasaa, "~> 0.4.0"}]
+  [{:paasaa, "~> 0.5.0"}]
 end
 ```
 
@@ -43,6 +43,12 @@ iex> Paasaa.all("Detect this!")
 ]
 ```
 
+## Benchmark
+
+```shell
+mix bench
+```
+
 ## Update Language Data
 
 ```shell

lib/paasaa.ex

@@ -133,6 +133,19 @@ defmodule Paasaa do
     end
   end
 
+  @doc """
+  Detects a script.
+
+  ## Parameters
+
+    - `str` - a text string
+
+  ## Examples
+
+      iex> Paasaa.detect_script("Detect this!")
+      {"Latin", 0.8333333333333334}
+  """
+
   @spec detect_script(str :: String.t()) :: {String.t(), number}
   def detect_script(str) do
     len = String.length(str)

mix.exs

@@ -4,8 +4,8 @@ defmodule Paasaa.Mixfile do
   def project do
     [
       app: :paasaa,
-      version: "0.4.0",
-      elixir: "~> 1.7",
+      version: "0.5.0",
+      elixir: "~> 1.8",
       description: description(),
       package: package(),
       deps: deps(),