v3.0.0

SSSSSSMOKIN'!

So, it seems you can add even more features to an already overcomplicated word-search puzzle generator 🤦‍♂️...

👺 Puzzle Masking

@duck57 started working on the idea of masking puzzles with issue #20, and here's the final result.

-----------------------------------------
               WORD SEARCH
-----------------------------------------
              I U D A J L W
          H E A R C W V N J V E
        N M D I O M R U X W I L L
      E A O A N J E O C I U K V P G
    S F M F     L T P A Z     U J T M
  B L U Y F     S H G M S     Y H G O F
  W S G T I     O O T E I     U F X C E
U X L A D C     C D H R N     J N K L V P
J N F T E I     I L E A C     K E B M L R
K W S C D A     A T S K E     D I U A Z O
X Q A J O L G U L B E O C R I S A E C E V
V E U C Z N N O T H I N G S S E D I G X E
P X Q K O W U E M E F O N O R Q L A P Y H
T J W S P     V Z C L I P A     H E R D W
  R P R Y                       T O R F
  G X F U W                   I T A Q A
    A V A I L A B L E A W M P S E W G
      B R U X Q F X E R K S I F H I
        K I Z E M D A B E H T J D
          F J N I C E D U Y Z I
              B J P Y B N H

Read all about puzzle masking in the new Wiki docs.

Somebody stop me!

♻️ Random Word Puzzles

🤷‍♂️ Can't think of any clever words for your puzzle. No problem...

>>> from word_search_generator import WordSearch
>>> puzzle = WordSearch()
>>> puzzle.random_words(10)

📑 Project Documentation

With all of the new features, I figured it was time to write some documentation... Read the docs in the GitHub project wiki. And, I'm certain I overlooked some things, so let me know if you need clarification on anything.

HAPPY WORD-SEARCHING ✌️