diff --git a/README.md b/README.md index 5c511a7..046b197 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,24 @@ -# wordlelm +# parlelm -a wordle clone in elm - WIP +an implementation of mastermind with 5 letter words on a constrained vocabulary with a UI +that might be inspired to something mentioned in this [article](https://www.404media.co/nytimes-files-copyright-takedowns-against-hundreds-of-wordle-clones/). -goal is to have a production full featured clone of wordle that can be used to replace https://github.com/pietroppeter/wordle-it +goal is to have in production version that can replace this (with changes in the UI, e.g. color changes) https://github.com/pietroppeter/wordle-it -after the current full feature set of wordle we will think about adding features, e.g.: +we still have to complete the MVP, these are some +ideas for additional features - play a past game - history of all your past games - share a custom game -I am a beginner in both Elm and functional languages. - Started at [![Open Source Saturday](https://img.shields.io/badge/%E2%9D%A4%EF%B8%8F-open%20source%20saturday-F64060.svg)](https://www.meetup.com/it-IT/Open-Source-Saturday-Milano/) +Shared project by @pietroppeter (beginner in Elm and functional languages) and @akiross (code ninja that wants to put more Elm in production). -Help on Elm by @akiross. - -We also tried to have a NixOS based Elm setup with help by @kristoff-it but it did not work out. +We also tried (on the first meetup) to have a NixOS based Elm setup with help by @kristoff-it but it did not work out. In the end it is actually very simple to just setup elm with the installer. -## plan - -- [ ] view (with elm-ui) - - [x] basic layout (grid and keyboard) - - [x] color the words -- [ ] logic of game and updates -- [ ] side effects (local storage, current date) - - ## tests using elm-explorations/test and node-test-runner - install using `npm install -g elm-test` -- test using `elm-test src/Word.elm` \ No newline at end of file +- test using `elm-test src/Word.elm`