From 94cb80c62750500b8b34adb673c88cfe41706fa1 Mon Sep 17 00:00:00 2001 From: Brian Wiborg Date: Mon, 3 Apr 2023 13:44:06 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index dadc1f8..28a5e50 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ A Python 3.11 module for votings on the c-base space-station. +## Getting Started + +``` +git clone https://code.c-base.org/baccenfutter/python-voting +cd python-voting +poetry install +``` + ## Usage ```python @@ -25,4 +33,27 @@ voting.vote('alice', Vote.YES) # obtaining the result res = Result(voting) print(res.result()) +``` + +## Command-line Interface + +``` +$> voting --help + + Usage: voting [OPTIONS] COMMAND [ARGS]... + +╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────╮ +│ --install-completion Install completion for the current shell. │ +│ --show-completion Show completion for the current shell, to copy it or customize the │ +│ installation. │ +│ --help Show this message and exit. │ +╰────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────╮ +│ ls List all votings. │ +│ new Create a new voting. │ +│ rm Delete a voting. │ +│ show Display the results of a voting. │ +╰────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +$> voting new EXAMPLE_TITLE --quorum A:5 --voters a,b,c,d,e,f,g,h,i,j ``` \ No newline at end of file