diff --git a/README.md b/README.md index d85a22f..ebbce05 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Add `argon2id_elixir` to your list of dependencies in `mix.exs`: ```elixir def deps do [ - {:argon2id_elixir, "~> 0.1.0"} + {:argon2id_elixir, "~> 1.1.1"} ] end ``` diff --git a/lib/argon2_elixir.ex b/lib/argon2_elixir.ex index f314444..76f8f4f 100644 --- a/lib/argon2_elixir.ex +++ b/lib/argon2_elixir.ex @@ -4,6 +4,29 @@ defmodule Argon2 do This module provides a secure way to hash passwords using the Argon2i algorithm. + ## Installation + + Add `argon2` to your list of dependencies in `mix.exs`: + + ``` + def deps do + [ + {:argon2id_elixir, "~> 1.1.1"} + ] + end + ``` + + Ensure you have Rust installed, as it's required for compilation: + + ```sh + # On Windows + winget install Rust.Rust + + # On Unix-like systems (https://rustup.rs/) + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` + + ## Security Presets * `:owasp` (default) - OWASP recommended settings (m=19456, t=2, p=1) diff --git a/mix.exs b/mix.exs index 6aab478..50a2b77 100644 --- a/mix.exs +++ b/mix.exs @@ -6,7 +6,7 @@ defmodule Argon2.MixProject do def project do [ app: :argon2id_elixir, - version: "1.1.0", + version: "1.1.1", elixir: "~> 1.17", start_permanent: Mix.env() == :prod, deps: deps(),