[add] added readme

README.md

@@ -0,0 +1,66 @@
+<h1 align="center">Wordle Finder</h1>
+
+<h4 align="center">
+	Totally not Cheating!&#8482;
+</h4>
+
+A tiny little helper for when one is all out of words and needs some made up ones. Side effects may include loosing ones streak.
+
+<p align="center">
+    <strong>
+        <a href="https://wofi.pdev.dev"><strike>cheat</strike> try now</a> 
+        • <a href="#how-to">How To</a>
+        • <a href="#roadmap">Roadmap</a>
+	</strong>
+</p>
+
+## How To
+
+### Syntax
+
+* `![a-z]*` - exclude any number of letters: `!tech` excludes all words with `t`, `e`, `c` , `h`
+* `[a-z]@[1-5]` - include letter at position: `k@1` includes all words with `k` as the first letter
+* `[a-z]?[1-5]` - include letter not at position: `a?2` includes words with `a` where it is not the second letter.
+* `[a-z]?6` - helper to find words with target letter: `j?6` includes all words with `j` at any position
+
+### Example
+
+1. Starting wordle
+
+![wordle1](doc/wordle_1.png)
+
+2. Add output to finder and click `find`:  
+   * no `a` and `e`: `!ae`
+   * include `g` but not at position `3`: `g?3`
+   * include `i` but not at position `4`: `i?4`
+   * include `s` but not at position `5`: `s?5`
+
+
+![wordle1](doc/finder_1.png)
+
+2. Click `save` to keep the current string. Find a word with more common letters:  
+   * delete the current string and find a word that includes `r`, `u`, `o`, `t` and press `find`
+   * find a word that includes `r` : `r?6`
+   * find a word that includes `u` : `u?6`
+   * find a word that includes `o` : `o?6`
+   * find a word that includes `t` : `t?6`
+
+![wordle1](doc/finder_2.png)
+
+3. Pick anything that looks good (no double letters, no letters previously used)
+
+![wordle1](doc/wordle_3.png)
+
+4. Clock `load` to restore previous string, add output to finder and click `find`:  
+   * no `u`, `r`, `b` and `o`: `!urbo`
+   * include `t` but not at position `1`: `t?1`
+
+![wordle1](doc/finder_3.png)
+
+5. Pick anything that looks good (or the last remaining if one is lucky)
+
+![wordle1](doc/wordle_4.png)
+
+## Roadmap
+* Add optional possible solution highlights (for when one is really desperate)
+* Add optional sorting by word [frequency](https://www.ugent.be/pp/experimentele-psychologie/en/research/documents/subtlexus)