From 5c54f2e2e09b0fc07bb690b46049e2f9cfd5f576 Mon Sep 17 00:00:00 2001
From: Yoshiki Shino <yoshiki.shino.tech@gmail.com>
Date: Mon, 7 Mar 2022 00:17:46 +0900
Subject: [PATCH] docs: update README

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 52b2f3b..1c67759 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # Dinner Slot Web
-WIP
+Generate random set from inputed food list.
+This application runs on only browser (no backend).
+https://yoshikipom.github.io/dinnerslot-web/
+
+## how to use
+- LIST tab
+  - input food names separated by line breaks
+- SLOT tab
+  - input `count` for random set size
+  - push `SLOT` button
+  - (optional) To change one item, push reload button on the item
+  - (optional) push `SHARE BY LINE` button to share the generated list to someone
+
+## run on local
+```
+yarn install
+yarn dev
+# access to http://localhost:3000
+```
+
+## deploy
+Deployment is done by github actions.
+The trriger is push to `main` branch.
+Please refer `.github/workflows/main.yml`