Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brenoepics authored Jan 25, 2024
1 parent 66f2dd7 commit 98a99bf
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ An unofficial Java library for translating text using Azure AI Cognitive Service
- [JavaDoc](https://brenoepics.github.io/at4j/javadoc/)

## 🎉 Basic Usage
> [!NOTE]
> Example repository [Azure-Translator-Example](https://github.com/brenoepics/Azure-Translator-Example)
The following example translates a simple Hello World to Portuguese, Spanish and French.
Expand Down Expand Up @@ -94,10 +95,16 @@ libraryDependencies += "io.github.brenoepics" % "at4j" % "0.0.6"
</details>

### 🔑 Azure Translator Keys
> tl;dr [Generate Here](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/TextTranslation).
> [!WARNING]
> Remember to **keep your keys secure and do not share them publicly**. If you believe that a key has been compromised, you must regenerate it in Azure's Panel.
> For more information, visit the [Azure portal](https://portal.azure.com/).
<details>
<summary>How to generate my own keys?</summary>


> tl;dr [Generate Here](https://portal.azure.com/#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/TextTranslation).
1. Sign in to the [Azure portal](https://portal.azure.com/).

2. In the left-hand menu, click on "Create a resource".
Expand Down Expand Up @@ -131,9 +138,6 @@ To use the free tier, you need to create an Azure account and set up a Translato
Please note that the free tier usage limits are subject to change by Azure, and it's recommended to check the current details on the Azure Pricing page.
</details>

Remember to **keep your keys secure and do not share them publicly**. If you believe that a key has been compromised, you must regenerate it in Azure's Panel.
For more information, visit the [Azure Pricing page](https://azure.microsoft.com/pricing/details/cognitive-services/translator/).

### Optional Logger Dependency

Any Log4j-2-compatible logging framework can be used to provide a more sophisticated logging experience
Expand Down

0 comments on commit 98a99bf

Please sign in to comment.