From a75c8ade5864ad19d3eba832ec358ddca82f169b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ale=C5=A1?= Date: Tue, 27 Aug 2024 11:22:48 +0200 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6f0961e..a25dc6c 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,6 @@ [![NPM Downloads](https://img.shields.io/npm/d18m/%40zerops%2Fzcli)](https://www.npmjs.com/package/@zerops/zcli) [![npm version](https://badge.fury.io/js/@zerops%2Fzcli.svg)](https://badge.fury.io/js/@zerops%2Fzcli) [![Discord](https://img.shields.io/discord/735781031147208777)](https://discord.gg/xxzmJSDKPT) -[![npm bundle size](https://img.shields.io/bundlephobia/min/%40zerops%2Fzcli)](https://www.npmjs.com/package/@zerops/zcli) @@ -36,17 +35,21 @@
-## Supported platforms +### Supported platforms - Windows - Linux - MacOS (arm64, amd64) - NixOS -## Requirements +### Optional requirements - [Wireguard](https://www.wireguard.com/install/) - utilized by `zcli vpn` command. + +
+ + ## Install zCLI ### Package managers @@ -82,12 +85,23 @@ curl -L https://zerops.io/zcli/install.sh | sh Currently, the zCLI is distributed for Linux (x86 & x64 architecture), macOS (x64 & M1 architecture) and Windows (x64 architecture). + + +
+ +
+ + > [!TIP] -> To download the zCLI directly, use the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub. +> To download the zCLI directly, locate the binary for your OS in the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub. + + +
+ ## Quick Start -- Create a new personal access token from [settings/token-management](http://app.zerops.io/settings/token-management). +- Create a new personal access token at [settings/token-management](http://app.zerops.io/settings/token-management) in Zerops GUI. - Login to zCLI using the personal access token using the following command: @@ -95,21 +109,32 @@ Currently, the zCLI is distributed for Linux (x86 & x64 architecture), macOS (x6 zcli login ``` -- Push your project using the following command: +- Run zcli to list commands and the current status ```Shell -zcli push +zcli ``` +
+ + + ## Additional Documentation For more information go through https://docs.zerops.io/references/cli. + +
+ + ## Want to Contribute? Contributions to zCLI are welcome and highly appreciated. However, We would like you to go through [CONTRIBUTING.md](https://github.com/zeropsio/zcli/blob/main/CONTRIBUTING.md). + +
+ ## Community To chat with other community members, you can join the [Zerops Discord Server](https://discord.gg/xxzmJSDKPT).