diff --git a/README.md b/README.md index 995ccc8c..af820972 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/tolgee-cli-screenshot.png b/tolgee-cli-screenshot.png new file mode 100644 index 00000000..5e6c6a47 Binary files /dev/null and b/tolgee-cli-screenshot.png differ