From b0e76b562d6301bee409a0c1c66bf7a43e23220e Mon Sep 17 00:00:00 2001 From: Lertsenem Date: Thu, 9 Jul 2020 15:40:16 +0200 Subject: [PATCH] Add basic usage to README --- README.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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 ------------