diff --git a/README.adoc b/README.adoc index 95190e0..7929e08 100644 --- a/README.adoc +++ b/README.adoc @@ -3,6 +3,18 @@ Lokrez A smash.gg-aware local-results generator for Super Smash Brothers Ultimate. +Usage +----- + +---- +$> lokrez -t [your-smash.gg-auth-token] top8 [tournament-slug-or-id] +---- + +The resulting outputs will be in +tournament-slug.lkrz+ (text version) and ++tournament-slug.svg+ (image version). + +Use the +--help+ option for further details. + Requirements ------------