Skip to content

Commit

Permalink
docs: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar committed Jan 12, 2024
1 parent 4ed60e8 commit f262d9c
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,23 @@ Integrate your Visual Studio Code projects with Crowdin to streamline the locali

A new component will be introduced in the Activity Bar called the *Crowdin*. The plugin will scan each workspace for a Crowdin-specific configuration file and will build a tree with source files.

### Sources and translations sync, tracking project progress
### Upload source files to Crowdin

With this plugin you can:
Upload source files to Crowdin for translation using the **"Upload"** panel. It displays all the source files matching the specified pattern in the configuration file. You can either individually select files to upload to Crowdin or upload all files at once.

- Upload files for translation to Crowdin.
- Download sources and translations from Crowdin.
- Track progress of translated and approved strings for each project and target language.
[<p align="center"><img src="resources/animations/upload.gif" data-canonical-src="resources/animations/upload.gif" width="800" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)

[<p align="center"><img src="resources/plugin.png" data-canonical-src="resources/plugin.png" width="300" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)
### Download source and translation files from Crowdin

Download source and translation files from Crowdin using the **"Download"** panel. It displays all the source files matching the specified pattern in the configuration file. You can download translations for all target languages as well as download source files edited in Crowdin.

[<p align="center"><img src="resources/animations/download.gif" data-canonical-src="resources/animations/download.gif" width="800" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)

### Track translation progress

Track progress of translated and approved strings for each project and target language.

[<p align="center"><img src="resources/animations/progress.gif" data-canonical-src="resources/animations/progress.gif" width="800" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)

### String keys autocompletion

Expand All @@ -37,10 +45,24 @@ There is a possibility to configure file extensions, where the string keys autoc

Strings for autocompletion are loaded during the bootstrap of VSCode and are also updated whenever there was a change in the `crowdin.yml` configuration file.

[<p align="center"><img src="https://raw.githubusercontent.com/crowdin/vscode-crowdin/docs/autocompletion-demo.gif" data-canonical-src="https://raw.githubusercontent.com/crowdin/vscode-crowdin/docs/autocompletion-demo.gif" width="700" height="auto" align="center"/></p>](https://github.com/crowdin/vscode-crowdin/releases/tag/1.4.0/)
[<p align="center"><img src="resources/animations/autocomplete.gif" data-canonical-src="resources/animations/autocomplete.gif" width="800" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)

This gif illustrates the autocompletion of string keys in a React project that uses the [Lingui](https://lingui.dev/tools/crowdin) library.

### Command Palette commands

The plugin provides the following commands in the VS Code [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-) (<kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd>/<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>):

- `Crowdin: Sign In` to log in into your Crowdin profile
- `Crowdin: Sign Out` to log out from your Crowdin profile
- `Crowdin: Select Project` to select Crowdin project
- `Crowdin: Open Configuration` to open Crowdin configuration file
- `Crowdin: Focus on Upload View` to focus on the Upload view
- `Crowdin: Focus on Download View` to focus on the Download view
- `Crowdin: Focus on Progress View` to focus on the Progress view

[<p align="center"><img src="resources/animations/command-palette.gif" data-canonical-src="resources/animations/command-palette.gif" width="800" height="auto" align="center"/></p>](https://store.crowdin.com/visual-studio-code/)

## Setup

### Installation
Expand Down
Binary file added resources/animations/autocomplete.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/animations/command-palette.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/animations/download.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/animations/progress.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/animations/upload.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed resources/plugin.png
Binary file not shown.

0 comments on commit f262d9c

Please sign in to comment.