diff --git a/README.md b/README.md index aac42f9..418f323 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ # Deckcard # The deck shuffeling and card drawing program -Better description to come (you know, once I actually build the thing) +Deckcard is a simple deck shuffeling and card drawing program, its designed to use deck definition files (written as a JSON object filled with only named arrays. + +An example of a deck definition file: + +``` +{ +"value":[ "A", "2", "3", "4", "5", "6", "7", "8", "9", "10", "J", "Q", "K"], +"suit":[ "♥", "♣", "♠", "♦"] +} +``` + +Using this you can make all kinds of decks. + +Things not yet supported: + * Unique cards + * Multipul card classes + * Mixing decks \ No newline at end of file