From da25d5d84e53d97b44ea1740ac9120330436756a Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 15 Feb 2024 19:22:41 -0300 Subject: [PATCH 1/4] update: CodeSee EOL --- .github/workflows/codesee-arch-diagram.yml | 23 ---------------------- 1 file changed, 23 deletions(-) delete mode 100644 .github/workflows/codesee-arch-diagram.yml diff --git a/.github/workflows/codesee-arch-diagram.yml b/.github/workflows/codesee-arch-diagram.yml deleted file mode 100644 index 806d41d..0000000 --- a/.github/workflows/codesee-arch-diagram.yml +++ /dev/null @@ -1,23 +0,0 @@ -# This workflow was added by CodeSee. Learn more at https://codesee.io/ -# This is v2.0 of this workflow file -on: - push: - branches: - - main - pull_request_target: - types: [opened, synchronize, reopened] - -name: CodeSee - -permissions: read-all - -jobs: - codesee: - runs-on: ubuntu-latest - continue-on-error: true - name: Analyze the repo with CodeSee - steps: - - uses: Codesee-io/codesee-action@v2 - with: - codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }} - codesee-url: https://app.codesee.io From 713de54789c089d64240e41d73c197fce3954710 Mon Sep 17 00:00:00 2001 From: Breno A Date: Fri, 16 Feb 2024 06:19:31 -0300 Subject: [PATCH 2/4] update: first sponsor! --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1a6098a..6b78855 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,9 @@ log levels per class, and much more. More info at our [Docs](https://brenoepics.github.io/at4j/guide/installation.html#logger-dependency) +## 🤝 Sponsors +- **Microsoft Azure**: Supporting our project with a generous grant of $10,000+ in Azure credits, enabling us to utilize virtual machines, document translation and other essential cloud resources for our development needs. + ## 📋 Version Numbers The version number has a 3-digit format: `major.minor.trivial` From 98016318fc44e0a3b5574e3312d6d193a595457c Mon Sep 17 00:00:00 2001 From: Breno A Date: Fri, 16 Feb 2024 06:33:50 -0300 Subject: [PATCH 3/4] update: fix README.MD --- README.md | 39 +++++++++------------------------------ 1 file changed, 9 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 6b78855..21a9c3d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=brenoepics_at4j&metric=coverage)](https://sonarcloud.io/summary/new_code?id=brenoepics_at4j) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=brenoepics_at4j&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=brenoepics_at4j) - An unofficial Java library for translating text using Azure AI Cognitive Services. ## ✨ Features @@ -97,41 +96,21 @@ libraryDependencies += "io.github.brenoepics" % "at4j" % "1.0.0" ``` -### 🔑 Azure Translator Keys -> [!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/). +### Frequently Asked Questions (FAQ) -- [How to generate my own keys?](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-subscription) -- [Azure Free Tier](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-free-tier) +**Q:** How do I access Azure Translator Keys for my project? -### Optional Logger Dependency +**A:** You can access your Azure Translator Keys through your Azure portal. Remember to keep your keys secure and refrain from sharing them publicly. If you suspect a key has been compromised, it's crucial to regenerate it promptly. For detailed instructions on generating your own keys, refer to [this guide](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-subscription). Additionally, you can explore the [Azure Free Tier](https://brenoepics.github.io/at4j/guide/azure-subscription.html#azure-free-tier) for more information. -Any Log4j-2-compatible logging framework can be used to provide a more sophisticated logging experience -with being able to configure log format, log targets (console, file, database, etc.), -log levels per class, and much more. +Optional Logger Dependency +**Q:** Is there a recommended logger dependency for the project? -More info at our [Docs](https://brenoepics.github.io/at4j/guide/installation.html#logger-dependency) +**A:** While our project is compatible with any Log4j-2-compatible logging framework, integrating one can enhance your logging experience significantly. This allows you to configure log format, log targets (console, file, database, etc.), log levels per class, and more. For further details, please visit our [Docs](https://brenoepics.github.io/at4j/guide/installation.html#logger-dependency). -## 🤝 Sponsors +## 🤝 Thank You! - **Microsoft Azure**: Supporting our project with a generous grant of $10,000+ in Azure credits, enabling us to utilize virtual machines, document translation and other essential cloud resources for our development needs. - -## 📋 Version Numbers - -The version number has a 3-digit format: `major.minor.trivial` -* `major`: Increased extremely rarely to mark a major release (usually a rewrite affecting very huge parts of the library). -* `minor`: Any backward incompatible change to the api wrapper. -* `trivial`: A backward compatible change to the **api wrapper**. This is usually an important bugfix (or a bunch of smaller ones) - or a backwards compatible feature addition. - -## 🔨 Deprecation Policy - -A method or class that is marked as deprecated can be removed with the next minor release (but it will usually stay for -several minor releases). A minor release might remove a class or method without having it deprecated, but we will do our -best to deprecate it before removing it. We are unable to guarantee this though, because we might have to remove / replace -something due to changes made by Azure, which we are unable to control. Usually you can expect a deprecated method or -class to stay for at least 6 months before it finally gets removed, but this is not guaranteed. - +- We extend our sincere thanks to all contributors for their invaluable contributions. + ## 🧑‍💻 Contributing Contributions of any kind are welcome. You can start contributing to this library by creating issues, submitting pull requests or giving a star to the project. From 1ab21246b56c21c24aa7913355e482a7d8acd0e0 Mon Sep 17 00:00:00 2001 From: Breno A Date: Fri, 16 Feb 2024 06:34:25 -0300 Subject: [PATCH 4/4] update: bump version --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index c44e0b6..4afebd5 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ 4.0.0 io.github.brenoepics at4j - 1.0.0 + 1.1.0 Azure Translator For Java