diff --git a/README.md b/README.md index abce54c..44a26ee 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,136 @@ Blackbird is the new automation backbone for the language technology industry. B -Documentation coming soon. +Crowdin is a cloud-based localization platform that helps businesses and organizations manage the translation of their software, apps, websites, and other digital content into multiple languages. It provides a collaborative environment where translators and project managers can work together to translate and localize content efficiently. + +##Connecting + +1. Navigate to apps and search for Crowdin. If you cannot find Crowdin then click _Add App_ in the top right corner, select Crowdin and add the app to your Blackbird environment. +2. Click _Add Connection_. +3. Name your connection for future reference e.g. 'My Crowdin connection'. +4. Click _Authorize connection_. +5. As a new window pops up, follow the instructions from Crowdin. +6. When you return to Blackbird, confirm that the connection has appeared and the status is _Connected_. + +![CrowdinBlackbirdConnection](image/README/CrowdinBlackbirdConnection.png) + +## Actions + +### Comment + +- **Add string comment** Add new string comment +- **Delete string comment** Delete specific string comment +- **Get string comment** Get specific string comment +- **List comments** List string comments for a project + +### File + +- **Add file** Add new file +- **Add or update file** Add or update file +- **Delete file** Delete specific file +- **Download file** Download specific file +- **Get file** Get specific file info +- **List files** List project files +- **Update file** Update an existing file with new content + +### Machine Translation + +- **List machine translation engines** List all machine translation engines +- **Translate lines via machine translation engine** Translate multiple text lines via machine translation engine +- **Translate via machine translation engine** Translate text via machine translation engine + +### Project + +- **Add project** Add new project +- **Delete project** Delete specific project +- **Get project** Get specific project +- **List projects** List all projects + +### Source String + +- **Add source string** Add new source string +- **Delete source string** Delete specific source string +- **Get source string** Get specific source string +- **List strings** List all project source strings + +### Task + +- **Add task** Add new task +- **Delete task** Delete specific task +- **Download task strings as XLIFF** Download specific task strings as XLIFF +- **Get task** Get specific task +- **List tasks** List all tasks + +### Translation + +- **Add file translation** Add new file translation +- **Add string translation** Add new string translation +- **Apply pre-translation** Apply pre-translation to chosen files +- **Delete translation** Delete specific translation +- **Download file translation** Builds and downloads the translation of a file +- **Get translation** Get specific translation +- **List language translations** List project language translations +- **List string translations** List project string translations + +### Translation Memory + +- **Add translation memory segment** Add new segment to the translation memory +- **Add translation memory** Add new translation memory +- **Delete translation memory** Delete specific translation memory +- **Download translation memory** Download specific translation memory +- **Export translation memory** Export specific translation memory +- **Get translation memory** Get specific translation memory +- **List translation memories** List all translation memories + +## Events + +### Comment + +- **On string comment created** On string comment created +- **On string comment deleted** On string comment deleted +- **On string comment restored** On string comment restored +- **On string comment updated** On string comment updated + +### File + + - **On file added** On file added +- **On file approved** On file approved +- **On file deleted** On file deleted +- **On file reverted** On file reverted +- **On file translated** On file fully translated +- **On file updated** On file updated + +### Project + +- **On project approved** On project approved +- **On project built** On project built +- **On project created** On project created +- **On project deleted** On project deleted +- **On project translated** On project translated + +### String + +- **On string added** On string added +- **On string deleted** On string deleted +- **On string updated** On string updated + +### Suggestion + +- **On suggestion added** On suggestion added +- **On suggestion approved** On suggestion approved +- **On suggestion deleted** On suggestion deleted +- **On suggestion disapproved** On suggestion disapproved +- **On suggestion updated** On suggestion updated + +### Task + +- **On task added** On task added +- **On task deleted** On task deleted +- **On task status changed** On task status changed + +### Translation + +- **On translation updated** On translation updated ## Feedback diff --git a/image/README/CrowdinBlackbirdConnection.png b/image/README/CrowdinBlackbirdConnection.png new file mode 100644 index 0000000..a9506fa Binary files /dev/null and b/image/README/CrowdinBlackbirdConnection.png differ