From 17dd3963028886d8b87539eed2cf39b89078e8f3 Mon Sep 17 00:00:00 2001 From: Shantanu Raj Date: Sat, 16 Dec 2023 15:30:54 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Update=20installation=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5affe65..67d5eb2 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,14 @@ cargo build # or cargo build --release Installing the binary. +### From [crates.io](https://crates.io/crates/toggl) + +```shell +cargo install toggl +``` + +### From source + ```shell cargo install --path . ``` @@ -42,7 +50,7 @@ Run the `help` command to see a list of available commands. ```shell $ toggl help -toggl 0.3.0 +toggl 0.4.1 Toggl command line app. USAGE: @@ -54,17 +62,18 @@ FLAGS: -V, --version Prints version information OPTIONS: + -C Change directory before running the command --proxy Use custom proxy SUBCOMMANDS: - auth + auth Authenticate with the Toggl API. Find your API token at https://track.toggl.com/profile#api-token config Manage auto-tracking configuration continue current help Prints this message or the help of the given subcommand(s) list running - start Start a new time entry. Call with no arguments to start in interactive mode. + start Start a new time entry, call with no arguments to start in interactive mode stop ``` @@ -72,22 +81,23 @@ You can also run the `help` command on a specific subcommand. ```shell $ toggl help start -toggl-start 0.1.0 -Start a new time entry. Call with no arguments to start in interactive mode. +toggl-start 0.4.1 +Start a new time entry, call with no arguments to start in interactive mode USAGE: toggl start [FLAGS] [OPTIONS] [description] FLAGS: -b, --billable - -h, --help Prints help information - -V, --version Prints version information + -h, --help Prints help information + -i, --interactive + -V, --version Prints version information OPTIONS: - -p, --project + -p, --project Exact name of the project you want the time entry to be associated with ARGS: - + Description of the time entry ``` ## Testing