From fca5c09f92ab1317283871bcb4c0b3632421c1a6 Mon Sep 17 00:00:00 2001 From: HugoRCD Date: Sun, 31 Mar 2024 12:46:55 +0200 Subject: [PATCH] docs: update main readme --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 42329b4..8d431d0 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,23 @@ npm install -g @shelve/cli ## Usage ```bash -USAGE shelve upgrade|login|logout|whoami|pull|push - -COMMANDS - - upgrade Upgrade the Shelve CLI to the latest version - link Link the current directory with a Shelve project - unlink Unlink the current directory from a Shelve project - login Authenticate with Shelve - logout Logout the current authenticated user - whoami Shows the username of the currently logged in user - pull Retrieve the environement variables from Shelve - push Send the environement variables to Shelve - open Open the current project in the browser - -Use shelve --help for more information about a command. +USAGE shelve [options] + +| Commands | Description | Shortcut | +|----------|------------------------------------------------------|-----------| +| create | Create a new Shelve project | c | +| init | alias for create | i | +| upgrade | Upgrade the Shelve CLI to the latest version | u | +| link | Link the current directory with a Shelve project | l | +| unlink | Unlink the current directory from a Shelve project | ul | +| login | Authenticate with Shelve | li | +| logout | Logout the current authenticated user | lo | +| whoami | Shows the username of the currently logged-in user | w | +| pull | Retrieve the environment variables from Shelve | pl | +| push | Send the environment variables to Shelve | ps | +| open | Open the current project in the browser | o | + +Use shelve --help for more information about a command. ```