Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshikipom committed Mar 6, 2022
1 parent a2acfea commit 5c54f2e
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 5c54f2e

Please sign in to comment.