Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 793 Bytes

README.md

File metadata and controls

28 lines (20 loc) · 793 Bytes

Pordle

An Elixir clone of the word game Wordle.

Installation

If available in Hex, the package can be installed by adding pordle to your list of dependencies in mix.exs:

def deps do
  [
    {:pordle, "~> 0.1.0"}
  ]
end

Provide a validate_with config option in your app's config/config.exs so that the game can validate player guesses. The function must return true or false. This option defaults to Pordle.Test.Dictionary in test/support/dictionary.ex.

config :pordle,
  validate_with: &Example.valid?/1

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/pordle.