Skip to content

Commit

Permalink
chore: Update README (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin005 authored May 18, 2023
1 parent b986b6f commit 5867b04
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
# Tolgee CLI 🐁

An experimental 🧪 command line tool to interact with Tolgee directly from your terminal.
A CLI tool to interact with Tolgee directly from your terminal.

The CLI lets you pull strings from the Tolgee platform into your projects, push local strings to the Tolgee platform,
The Tolgee CLI lets you pull strings from the Tolgee platform into your projects, push local strings to the Tolgee platform,
extract strings from your code, and much more!

- Pull requests welcome! 🤩
![Tolgee CLI screenshot](tolgee-cli-screenshot.png)

## Installation
The Tolgee CLI is published as a NPM package. You simply need to install it, and you're good to go!

```sh
# npm
npm i --global @tolgee/cli
```

> **Warning**: The Tolgee CLI is currently experimental and subject to bugs. Breaking changes may happen before stable release!
>
> Help us reach stable version faster by reporting any bug you encounter on the [issue tracker](https://github.com/tolgee/tolgee-cli/issues/new?labels=bug).
> Feedback is also greatly appreciated!
# Yarn
yarn global add @tolgee/cli

# pnpm
pnpm add --global @tolgee/cli
```

See our [documentation](https://tolgee.io/tolgee-cli/installation) for more information.

Expand Down
Binary file added tolgee-cli-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5867b04

Please sign in to comment.