diff --git a/README.md b/README.md index 873c217..b120e62 100644 --- a/README.md +++ b/README.md @@ -284,6 +284,10 @@ Then create the secrets `CROWDIN_PROJECT_ID` and `CROWDIN_PERSONAL_TOKEN` and fi If comparing the native GitHub integration and the GitHub Action, the GitHub Action provides more flexibility and control over the localization process. +## Acknowledging translators + +Use the [Crowdin Contributors](https://github.com/marketplace/actions/action-crowdin-contributors) action to generate a table of your project's top translators and proofreaders in the README. See the [example](/docs/EXAMPLES.md#acknowledging-translators) for details. + ## Contributing If you would like to contribute, please read the [Contributing](/CONTRIBUTING.md) guidelines. diff --git a/docs/EXAMPLES.md b/docs/EXAMPLES.md index 2fccc47..7453555 100644 --- a/docs/EXAMPLES.md +++ b/docs/EXAMPLES.md @@ -27,6 +27,7 @@ - [Checking the translation progress](#checking-the-translation-progress) - [Pre-Translation](#pre-translation) - [Run test workflows on all commits of a PR](#run-test-workflows-on-all-commits-of-a-pr) + - [Acknowledging translators](#acknowledging-translators) - [Automatic AI Pre-Translation](AI.md) --- @@ -679,3 +680,18 @@ To avoid this, add a custom PAT to the checkout action: with: token: ${{ secrets.GHA_CUSTOM_PAT }} ``` + +### Acknowledging translators + +Use the [Crowdin Contributors](https://github.com/marketplace/actions/action-crowdin-contributors) action to generate a table of your project's top translators and proofreaders in the README. It uses the same Crowdin credentials: + +```yaml +- name: Generate Crowdin Contributors table + uses: andrii-bodnar/action-crowdin-contributors@v3 + with: + contributors_per_line: 8 + max_contributors: 32 + env: + CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }} + CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} +```