From 59c379edec572283fd3e9fb8303398cf11f1af06 Mon Sep 17 00:00:00 2001 From: Andrii Bodnar Date: Fri, 5 Jan 2024 11:01:19 +0200 Subject: [PATCH] docs: update badges and installation guide (#698) --- README.md | 5 +++-- website/docs/installation.md | 40 ++++++++++++++++++------------------ website/docs/intro.md | 8 ++++++-- 3 files changed, 29 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a7c22dd71..9b5da1871 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,9 @@ This is a cross-platform and it runs in a terminal on Linux based and macOS oper [![Docker Pulls](https://img.shields.io/docker/pulls/crowdin/cli?logo=docker&cacheSeconds=2000)](https://hub.docker.com/r/crowdin/cli) [![npm](https://img.shields.io/npm/dt/@crowdin/cli?logo=npm&cacheSeconds=2000)](https://www.npmjs.com/package/@crowdin/cli) [![homebrew downloads](https://img.shields.io/homebrew/installs/dy/crowdin?logo=homebrew)](https://formulae.brew.sh/formula/crowdin) -![GitHub all releases](https://img.shields.io/github/downloads/crowdin/crowdin-cli/total?label=assets%20downloads&logo=github&cacheSeconds=2000) -[![GitHub Used by](https://img.shields.io/static/v1?label=Used%20by&message=1.5k&color=brightgreen&logo=github&cacheSeconds=10000)](https://github.com/crowdin/crowdin-cli/network/dependents) +[![Chocolatey](https://img.shields.io/chocolatey/dt/crowdin-cli?logo=chocolatey&cacheSeconds=2000)](https://community.chocolatey.org/packages/crowdin-cli) +[![GitHub all releases](https://img.shields.io/github/downloads/crowdin/crowdin-cli/total?label=assets%20downloads&logo=github&cacheSeconds=2000)](https://github.com/crowdin/crowdin-cli/releases) +[![GitHub Used by](https://img.shields.io/static/v1?label=used%20by&message=1.5k&color=brightgreen&logo=github&cacheSeconds=10000)](https://github.com/crowdin/crowdin-cli/network/dependents) [![build-test](https://github.com/crowdin/crowdin-cli/actions/workflows/build-test.yml/badge.svg?branch=main)](https://github.com/crowdin/crowdin-cli/actions/workflows/build-test.yml) [![CodeQL](https://github.com/crowdin/crowdin-cli/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/crowdin/crowdin-cli/actions/workflows/codeql-analysis.yml) diff --git a/website/docs/installation.md b/website/docs/installation.md index 704f459ee..5b34e2a1e 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -4,7 +4,7 @@ description: Install Crowdin CLI easily with clear instructions on the installat # Installation -## Homebrew for macOS +## Homebrew To install the Crowdin CLI with [Homebrew](https://brew.sh/) (the package manager for macOS): @@ -18,11 +18,23 @@ brew install crowdin@3 [Homebrew Tap Reference](https://github.com/crowdin/homebrew-crowdin). -## Windows +## NPM -### Installer +```bash +npm i -g @crowdin/cli +``` -Download and run [installer for Windows](https://downloads.crowdin.com/cli/v3/crowdin.exe). +[NPM Package Reference](https://www.npmjs.com/package/@crowdin/cli). + +## Docker + +```bash +docker pull crowdin/cli +``` + +[Docker Container Reference](https://hub.docker.com/r/crowdin/cli). + +## Windows ### Chocolatey @@ -32,6 +44,10 @@ choco install crowdin-cli [Chocolatey Package Reference](https://community.chocolatey.org/packages/crowdin-cli). +### Installer + +Download and run [installer for Windows](https://downloads.crowdin.com/cli/v3/crowdin.exe). + ## Debian We sign all our packages with the Crowdin Signing Key. @@ -102,22 +118,6 @@ sudo rpm -U crowdin.rpm Visit the [Crowdin CLI package page](https://aur.archlinux.org/packages/crowdin-cli) on Arch Linux user repository. -## NPM - -```bash -npm i -g @crowdin/cli -``` - -[NPM Package Reference](https://www.npmjs.com/package/@crowdin/cli). - -## Docker - -```bash -docker pull crowdin/cli -``` - -[Docker Container Reference](https://hub.docker.com/r/crowdin/cli). - ## Standalone version Crowdin CLI can be installed as a stand-alone Java application. [Download](https://github.com/crowdin/crowdin-cli/releases/latest/download/crowdin-cli.zip). diff --git a/website/docs/intro.md b/website/docs/intro.md index 686509a48..97e7e951c 100644 --- a/website/docs/intro.md +++ b/website/docs/intro.md @@ -17,8 +17,12 @@ This is a cross-platform, and it runs in a terminal on Linux based and macOS ope [![Docker Pulls](https://img.shields.io/docker/pulls/crowdin/cli?logo=docker&cacheSeconds=2000)](https://hub.docker.com/r/crowdin/cli) [![npm](https://img.shields.io/npm/dt/@crowdin/cli?logo=npm&cacheSeconds=2000)](https://www.npmjs.com/package/@crowdin/cli) [![homebrew downloads](https://img.shields.io/homebrew/installs/dy/crowdin?logo=homebrew)](https://formulae.brew.sh/formula/crowdin) -[![GitHub contributors](https://img.shields.io/github/contributors/crowdin/crowdin-cli?cacheSeconds=1000)](https://github.com/crowdin/crowdin-cli/graphs/contributors) +[![Chocolatey](https://img.shields.io/chocolatey/dt/crowdin-cli?logo=chocolatey&cacheSeconds=2000)](https://community.chocolatey.org/packages/crowdin-cli) +[![GitHub all releases](https://img.shields.io/github/downloads/crowdin/crowdin-cli/total?label=assets%20downloads&logo=github&cacheSeconds=2000)](https://github.com/crowdin/crowdin-cli/releases) [![codecov](https://codecov.io/gh/crowdin/crowdin-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/crowdin/crowdin-cli) + +[![GitHub Used by](https://img.shields.io/static/v1?label=used%20by&message=1.5k&color=brightgreen&logo=github&cacheSeconds=10000)](https://github.com/crowdin/crowdin-cli/network/dependents) +[![GitHub contributors](https://img.shields.io/github/contributors/crowdin/crowdin-cli?cacheSeconds=1000)](https://github.com/crowdin/crowdin-cli/graphs/contributors) ![GitHub](https://img.shields.io/github/license/crowdin/crowdin-cli?cacheSeconds=50000) [![GitHub Repo stars](https://img.shields.io/github/stars/crowdin/crowdin-cli?style=social&cacheSeconds=1800)](https://github.com/crowdin/crowdin-cli/stargazers) @@ -26,7 +30,6 @@ This is a cross-platform, and it runs in a terminal on Linux based and macOS ope ## Features -- Interactive generation of a configuration file - Upload source files and existing translations to a Crowdin project - Download the latest translations from Crowdin to the specified place - Multithreading for source and translation files upload @@ -39,6 +42,7 @@ This is a cross-platform, and it runs in a terminal on Linux based and macOS ope - Bash/Zsh command completion - Process indicators, loading states, emojis - HTTP Proxy support including authorization +- Interactive generation of a configuration file - and more. ## Usage