wordler 0.3.1

Library and cli for Wordle
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Wordle in Rust

A Rust library and cli for [Wordle](https://www.powerlanguage.co.uk/wordle/).
Inspired by [Wordle in Bash](https://gist.github.com/huytd/6a1a6a7b34a0d0abcac00b47e3d01513)

## Install

```bash
brew install 64bit/tap/wordler
```

OR

```bash
cargo install wordler
```

## Play

```
wordler
```

![Play Demo](play-demo.gif)


## Basic Library Usage

```rust
use wordler::dictionary::EnglishDictionary;
use wordler::wordle::{Wordle, PlayResult};

// You can implement Dictionary Trait for custom dictionaries
let dictionary = EnglishDictionary::new().unwrap();

//  Initialize game with a valid dictionary
let mut wordle = Wordle::new(&dictionary);

// Game Turn
let play_result = wordle.play("dream");

// Turn Result
match play_result {
  Ok(play_result) => {
    println!("{}", play_result);
    match play_result {
        PlayResult::YouWon(_) => std::process::exit(0),
        PlayResult::YouLost(_, _) => std::process::exit(1),
        PlayResult::TurnResult(_) => {}
    }
  }
  Err(e) => println!("{}", e),
}
```