Merge pull request #11 from MiracleUFO/README-patch

chore: updated readme

.eslintrc.js

@@ -11,7 +11,7 @@ module.exports = {
       },
       alias: {
         map: [['~', './src/']],
-        extensions: ['.ts', '.js', '.tsx'],
+        extensions: ['.ts', '.js', '.jsx', '.tsx'],
       },
     },
   },
@@ -32,11 +32,20 @@ module.exports = {
     '@typescript-eslint',
   ],
   rules: {
-    "react/function-component-definition": [
-      2,
+    'no-plusplus': 'off',
+    'no-console': ['warn', { allow: ['error', 'warn'] }],
+    'import/extensions': ['error', {
+      ts: 'never',
+      tsx: 'never',
+      js: 'never',
+      jsx: 'never',
+    }],
+    'react/jsx-filename-extension': 'off',
+    'react/function-component-definition': [
+      'error',
       {
-        namedComponents: "arrow-function" | "function-expression" | "function-declaration",
-        unnamedComponents: "arrow-function" | "function-expression" | "function-declaration",
+        namedComponents: ['function-declaration', 'arrow-function'],
+        unnamedComponents: 'arrow-function',
       },
     ],
   },

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [16.x, 18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.github/workflows/super-linter.yml

@@ -25,5 +25,7 @@ jobs:
         uses: github/super-linter@v4
         env:
           VALIDATE_ALL_CODEBASE: false
+          VALIDATE_MARKDOWN: false
           DEFAULT_BRANCH: "main"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_MARKDOWN: false

README.md

@@ -8,7 +8,7 @@ A modern, *free*, *lightweight* npm package for translating react apps (pages an
 - Spelling and Language correction
 - Fast and reliable – it uses the same servers that [translate.google.com](https://translate.google.com) uses
 - Allows to set defualt language and destination language in code.
-- Translates entires pages and just text.
+- Translates entire pages and just text.
 - Allows for custom language list files. (Coming in v2.0.0)
 
 ## Install
@@ -21,8 +21,8 @@ or with yarn
 ## Usage
 
 ### To translate whole component:
-```jsx (index.jsx)
-import Translator from 'react-auto-translate';
+```jsx
+import Translator from 'react-g-translate';
 
 return (
   <Translator
@@ -36,7 +36,7 @@ return (
 
 ### To translate specific text inline:
 ```jsx
-import { Translate } from 'react-auto-translate';
+import { Translate } from 'react-g-translate';
 
 return (
   <div>
@@ -51,7 +51,7 @@ return (
 ### To change to and from props dynamically:
 Overrides `to` and `from` of the <Translator> and <Translate> wrappers across the app (*Use with care*).
 ```jsx
-import { useTranslate } from 'react-auto-translate';
+import { useTranslate } from 'react-g-translate';
 
 const { setLanguageFrom, setLanguageTo } = useTranslate();
 
@@ -67,7 +67,7 @@ return (
 
 ### To get translation of text directly:
 ```jsx
-import { useTranslate } from 'react-auto-translate';
+import { useTranslate } from 'react-g-translate';
 
 const { translate } = useTranslate();
 const helloInIgbo = translate('Hello', 'en', 'ig');