update readme

1 files changed, 26 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..59a86c9
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Word Search Game
+================
+
+A word search game built with the JavaScript Canvas API. It supports mouse,
+touch, and keyboard selection, and is straightforward to customize.
+
+
+Development
+===========
+
+The script uses ES modules, so `index.html` must be served via an HTTP
+server rather than opened directly from the filesystem.
+
+  npx serve .
+
+
+Author
+======
+
+Zhineng Li <[email protected]>
+
+
+License
+=======
+
+The code is released under the MIT license.