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 May 22, 2024
1 parent ba845fd commit 100b213
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

The Crowdin Context Harvester CLI is designed to streamline the process of extracting context for translatable strings in your Crowdin projects. By leveraging Large Language Models (LLMs), it automatically analyzes your project code to determine how each key is used, enhancing the accuracy of translations.

<div align="center">

[![npm](https://img.shields.io/npm/v/crowdin-context-harvester?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/crowdin-context-harvester)
[![npm](https://img.shields.io/npm/dt/crowdin-context-harvester?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/crowdin-context-harvester)

</div>

## Features

- **Automated Context Extraction**: Pulls keys from your Crowdin project and analyzes your code to extract usage context.
Expand All @@ -10,6 +17,12 @@ The Crowdin Context Harvester CLI is designed to streamline the process of extra
- **CroQL Query Support**: Allows advanced filtering of Crowdin resources.
- **Custom Prompting**: Enables custom prompts for tailored context extraction.

## Installation

```
npm i -g crowdin-context-harvester
```

## Usage

Run the CLI with the following command:
Expand Down

0 comments on commit 100b213

Please sign in to comment.