@ogs-gmbh/ngx-translate 1.4.0 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH
+Copyright (c) 2025 — present OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,50 +1,105 @@
-# i18n Translation Library
-
-![GitHub License](https://img.shields.io/github/license/OGS-GmbH/ngx-translate?color=0f434e)
-![NPM Version](https://img.shields.io/npm/v/%40ogs-gmbh%2Fngx-translate?color=0f434e)
-![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/OGS-GmbH/ngx-translate/main-deploy.yml?color=0f434e)
-
-This Angular i18n library offers a REST-based approach to internationalization, with support for chunked and token-based translation loading.
-
-Translations are retrieved dynamically from remote endpoints, allowing for modular and scalable language management, especially in large applications or multi-tenant environments.
-
-Each translation chunk is associated with a specific feature or module, and access can be controlled via authentication tokens. The library enables runtime language switching and supports nested keys (multi-chunks).
-
-Its clean API and minimal setup make it easy to integrate into both new and existing projects.
-
-## Installation
-To get started, you can install this package using your preferred package manager.
-````shell
-npm install @ogs-gmbh/ngx-translate
-````
-
-<details>
-<summary>Other package manager</summary>
-<br />
-
-````shell
-yarn add @ogs-gmbh/ngx-translate
-````
-
-````shell
-pnpm install @ogs-gmbh/ngx-translate
-````
-
-</details>
-
-## License
-The MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) for more details.
-
-## Contributing
-Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.
-
-If you're unsure where to start, check the open issues for guidance. Even small contributions, such as fixing typos or improving code readability, are valuable.
-
-Feel free to submit a pull request or start a discussion — we're happy to collaborate!
-
----
-
-<a href="https://www.ogs.de/en/"><img src="https://www.ogs.de/fileadmin/templates/main/img/logo.png" height="32" /></a>
-<p>Gesellschaft für Datenverarbeitung und Systemberatung mbH</p>
-
-[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)
+> *We're OGS, check out our work on [github.com/ogs-gmbh](https://github.com/ogs-gmbh)*
+
+# ngx-translate
+
+![Preview](./docs/preview.avif)
+
+<a href="./LICENSE" target="_blank"><img src="https://img.shields.io/github/license/OGS-GmbH/ngx-translate?color=0f434e&logo=hackthebox&logoColor=000000&labelColor=ffffff" /></a>
+<a href="https://github.com/OGS-GmbH/ngx-translate/actions/workflows/main-deploy.yml" target="_blank"><img src="https://img.shields.io/github/actions/workflow/status/OGS-GmbH/ngx-translate/main-deploy.yml?color=0f434e&logo=rocket&logoColor=000000&labelColor=ffffff" /></a>
+<a href="https://www.npmjs.com/package/@ogs-gmbh/ngx-translate" target="_blank"><img src="https://img.shields.io/npm/v/%40ogs-gmbh%2Fngx-translate?color=0f434e&logo=npm&logoColor=000000&labelColor=ffffff" /></a>
+
+- **REST-based**\
+  Save, query and provide translations by API.
+
+- **Optimized for performance**\
+  Pre-load, lazy-load and cache your translations
+
+- **Multi-scoping ready**
+  Request multiple scopes which include translations at once
+
+- **Developer experience**\
+  Use a local language for development & production
+
+## Getting Started
+
+> [!IMPORTANT]
+> We're offering an extensive API-Reference covered with in-depth usage examples of this project.
+
+To get a starting point, simply refer to our documentation at [ogs-gmbh.github.io/ngx-translate](https://ogs-gmbh.github.io/ngx-translate).
+
+## Prerequisites
+
+- Node.js version 18 or higher
+- A package manager: e.g. npm, pnpm, ...
+
+## Installation
+
+Using npm:
+```sh
+$ npm install @ogs-gmbh/ngx-translate
+```
+
+<details>
+  <summary>Using a different package managers?</summary>
+  <br/>
+  
+  Using yarn:
+  ```sh
+  $ pnpm add @ogs-gmbh/ngx-translate
+  ```
+  
+  Using pnpm:
+  ```sh
+  $ pnpm add @ogs-gmbh/ngx-translate
+  ```
+  
+  Using bun:
+  ```sh
+  $ bun add @ogs-gmbh/ngx-translate
+  ```
+
+</details>
+
+## License
+
+The MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) for more details.
+
+## Contributing
+Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.
+
+Feel free to submit a pull request, issue or feature request.
+
+### Issues and Feature Requests
+Reporting an issue or creating a feature request is made by creating a new issue on this repository.
+
+You can create a [new issue or feature request here](../../issues/new/choose).
+
+### Pull Requests
+GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.
+
+You can find the [guidelines here](https://docs.github.com/get-started/exploring-projects-on-github/contributing-to-a-project).
+
+### Code Of Conduct
+We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Disclaimer
+
+All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.
+
+This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.
+
+---
+
+<a href="https://www.ogs.de/en/">
+  <picture>
+    <source
+      srcset="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg"
+      media="(prefers-color-scheme: dark)"
+    />
+    <img height="64" alt="OGS Logo" src="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg"
+  </picture>
+</a>
+
+Gesellschaft für Datenverarbeitung und Systemberatung mbH
+
+[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)