Merge pull request #30 from hergetto/chore/update-version

[Chore]: Update version to v0.2.0

Author: dustessavdh

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.2.0 (2024-01-30)
+
+- Add support to use options on translate ([#26](https://github.com/hergetto/deepl_ex/pull/26))
+
 ## v0.1.1 (2023-08-22)
 
 - Automatically determine the tier based on the api key ([#12](https://github.com/hergetto/deepl_ex/pull/12))

lib/deepl_ex.ex

@@ -12,6 +12,8 @@ defmodule DeeplEx do
   This function translates the given text from the given source language, to the given target language.
   It either returns `{:ok, translation}` or `{:error, error}`.
 
+  See `DeeplEx.LanguageValidator` and `DeeplEx.OptionsValidator` for more information about the allowed values.
+
   ## Example with correct input
 
 
@@ -27,6 +29,13 @@ defmodule DeeplEx do
     iex> DeeplEx.translate("Hoje vou comer.", :ZZ, :EN)
     {:error, :invalid_language_specification}
     ```
+    
+  ## Example when using options
+
+    ```elixir
+    iex> DeeplEx.translate("Hello, how are you?", :EN, :PT_BR, %{formality: "less"})
+    {:ok, "Olá, cara, como você está?"}
+    ```
   """
   def translate(
         text,

mix.exs

@@ -1,7 +1,7 @@
 defmodule DeeplEx.MixProject do
   use Mix.Project
 
-  @version "0.1.1"
+  @version "0.2.0"
   @source_url "https://github.com/hergetto/deepl_ex"
 
   def project do