From 181f3479d21e62fffa870a4299ca3a846df45ad2 Mon Sep 17 00:00:00 2001 From: Harminder Virk Date: Fri, 8 Sep 2023 10:14:37 +0530 Subject: [PATCH] docs: update readme file --- README.md | 64 +++++++++++++++++++------------------------------------ 1 file changed, 22 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 301fdc6..bc5ab2f 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,33 @@ -
- -
+# @adonisjs/i18n
-
-

Internationalization

-

The official package to add support for I18n to AdonisJS applications. It has support for formatting numbers, currencies, date/time and messages using the ICU syntax .

-
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] -
+## Introduction +Internationalization and Localization integration for AdonisJS with support for **ICU messages syntax**. -
- -[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url] - -
- -
-

- - Website - - | - - Guides - - | - - Contributing - -

-
- -
- Built with ❤︎ by Harminder Virk -
- -[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/i18n/test?style=for-the-badge -[gh-workflow-url]: https://github.com/adonisjs/i18n/actions/workflows/test.yml "Github action" +## Official Documentation +The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/i18n) -[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript -[typescript-url]: "typescript" +## Contributing +One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework. + +We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework. + +## Code of Conduct +In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md). + +## License +AdonisJS i18n is open-sourced software licensed under the [MIT license](LICENSE.md). + +[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/i18n/test.yml?style=for-the-badge +[gh-workflow-url]: https://github.com/adonisjs/i18n/actions/workflows/test.yml "Github action" [npm-image]: https://img.shields.io/npm/v/@adonisjs/i18n/latest.svg?style=for-the-badge&logo=npm [npm-url]: https://www.npmjs.com/package/@adonisjs/i18n/v/latest "npm" -[license-image]: https://img.shields.io/npm/l/@adonisjs/i18n?color=blueviolet&style=for-the-badge -[license-url]: LICENSE.md "license" +[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript -[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/i18n?label=Synk%20Vulnerabilities&style=for-the-badge -[synk-url]: https://snyk.io/test/github/adonisjs/i18n?targetFile=package.json "synk" +[license-url]: LICENSE.md +[license-image]: https://img.shields.io/github/license/adonisjs/i18n?style=for-the-badge