docs(readme): enhance content of readme (#60)

- fix package names - add badges
BedrockStreaming · Mar 10, 2021 · b3eeb1d · b3eeb1d
1 parent ad42ae4
commit b3eeb1d
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 16 deletions.
diff --git a/packages/eslint-plugin-i18n/README.md b/packages/eslint-plugin-i18n/README.md
@@ -1,11 +1,19 @@
-# eslint-plugin-m6web-i18n
+# @m6web/eslint-plugin-i18n
+
+[![Continous Integration](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml)
+![npm](https://img.shields.io/npm/v/@m6web/eslint-plugin-i18n)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/@m6web/eslint-plugin-i18n)
+![npm](https://img.shields.io/npm/dy/@m6web/eslint-plugin-i18n)
+![GitHub last commit](https://img.shields.io/github/last-commit/M6Web/i18n-tools)
+![NPM](https://img.shields.io/npm/l/@m6web/eslint-plugin-i18n)
 
 This is an [eslint](http://eslint.org/) plugin for i18n in a [react](https://facebook.github.io/react/) application.
+This plugin provides you with a set of rules to check the correct use of the translation keys but also forces you not to introduce untranslated texts in your React components.
 
 ## Installation
 
 ``` shell
-yarn add -D eslint-plugin-m6web-i18n
+yarn add -D @m6web/eslint-plugin-i18n
 ```
 
 ## Build
@@ -14,16 +22,6 @@ yarn add -D eslint-plugin-m6web-i18n
 yarn build
 ```
 
-## Bump
-
-To bump we use [mvrsion](https://www.npmjs.com/package/mversion).
-
-example:
-```shell
-yarn mversion -- patch -m
-```
-
-
 ## Rules
 
  * **i18n/no-unknown-key**: Verify that all translation keys you use are present in your primary translation files.

diff --git a/packages/i18n-lint/README.md b/packages/i18n-lint/README.md
@@ -1,23 +1,32 @@
-# i18n-lint
+# @m6web/i18n-lint
 
-Linter for i18n translation files
+[![Continous Integration](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml)
+![npm](https://img.shields.io/npm/v/@m6web/i18n-lint)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/@m6web/i18n-lint)
+![npm](https://img.shields.io/npm/dy/@m6web/i18n-lint)
+![GitHub last commit](https://img.shields.io/github/last-commit/M6Web/i18n-tools)
+![NPM](https://img.shields.io/npm/l/@m6web/i18n-lint)
+
+Linter for i18n translation files used at [Bedrock Streaming](https://www.bedrockstreaming.com/)
 
 ## Install
+
 ```sh
 yarn add -D i18n-lint
 
 yarn i18n-lint --config tests/test.config.json
 ```
 
 ## Config
+
 ```json
 {
   "path": "./tests/i18n"
 }
 ```
 
-
 ## Contributing
+
 ### Setup
 ```sh
 yarn

diff --git a/packages/react-i18n/README.md b/packages/react-i18n/README.md
@@ -1,4 +1,12 @@
-# React i18n for 6play apps
+# @m6web/react-i18n
+
+[![Continous Integration](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/M6Web/i18n-tools/actions/workflows/continuous-integration.yml)
+![npm](https://img.shields.io/npm/v/@m6web/react-i18n)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/@m6web/react-i18n)
+![npm](https://img.shields.io/npm/dy/@m6web/react-i18n)
+![GitHub last commit](https://img.shields.io/github/last-commit/M6Web/i18n-tools)
+![NPM](https://img.shields.io/npm/l/@m6web/react-i18n)
+
 
 This library brings internationalisation through a set of react components.