From 99ecba369c2ef52415d2667daa6baa40f4286d4c Mon Sep 17 00:00:00 2001
From: dm1sh <me@dmitriy.icu>
Date: Fri, 8 Jul 2022 00:15:08 +0300
Subject: [PATCH] Added readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6861dff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Gordle
+
+Go implementation of Wordle game
+
+## Building instructions
+
+```bash
+git clone https://git.dmitriy.icu/dm1sh/gordle
+cd gordle
+go mod tidy
+go build .
+```
+
+## Running instructions
+
+```bash
+% ./gordle --help                                                                                                                                                              
+Usage of ./gordle:
+  -n int
+        Word size (default 5)
+```
+
+## Dictionaries
+
+To run game you also need dictionary files. By default gordle searches for them in `./dictionary/<n>.txt` file, where `<n>` - number of characters, specified by `-n` flag