diff --git a/README.md b/README.md index 1e04c2d..117f8f5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,25 @@ # Wordle🔡 -

-A recreation of the popular game [Wordle](https://www.nytimes.com/games/wordle/index.html) by Josh Wardle/The New York Times, written in Java. -

-It needs just some finishing touches.. (bug fixes, cleaning up code etc.) +## Info -## Quick guide (will add more info on how to run it..) -1. ... +This repo contains a recreation of the popular game [Wordle](https://www.nytimes.com/games/wordle/index.html) by Josh Wardle/The New York Times, written in Java. + +Currently the game is working ok as a beta, but it needs some finishing touches (aka fix bugs, clean up code etc..) + +## What I've learned from the project so far + +- How to use SceneBuilder in Java +- How FXML works +- How to effectively write JavaDoc + +## Future plans: + +- [ ] Create a *quick guide* on how to run it locally +- [ ] Fix bugs + - [ ] user can keep playing when correct word is guessed + - [ ] user can keep playing even when amount of tries is used up +- [ ] Add info in ***Credits*** & ***How to play*** section + +## Beta preview + +https://user-images.githubusercontent.com/93219711/232312977-f68f73cc-4207-488d-87e1-e25fda8acc59.mp4