Merge pull request #15 from AuroPick/development

v4.0.0

.eslintrc

@@ -0,0 +1,17 @@
+{
+  "extends": ["@gokarma/karma-social-typescript"],
+  "rules": {
+    "@gokarma/react-native/no-unused-styles": "off",
+    "@gokarma/react-native/no-inline-styles": "off",
+    "@gokarma/react-native/no-color-literals": "off",
+    "@gokarma/react-native/sort-styles": "off",
+    "@gokarma/react-native/split-platform-components": "off",
+    "@gokarma/react-native/no-raw-text": "off",
+    "@gokarma/react-native/no-single-element-style-arrays": "off",
+    "jsx-a11y/click-events-have-key-events": "off"
+  },
+  "env": {
+    "node": true,
+    "jest": true
+  }
+}

.gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+dist

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "requirePragma": false,
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "quoteProps": "as-needed",
+  "singleQuote": true,
+  "semi": false,
+  "printWidth": 100,
+  "useTabs": false,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "endOfLine": "lf",
+  "insertPragma": false
+}

.vscode/settings.json

@@ -0,0 +1,46 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "files.eol": "\n",
+  "editor.wordWrap": "on",
+  "editor.fontLigatures": true,
+  "editor.formatOnPaste": true,
+  "editor.tabSize": 2,
+  "files.autoSave": "afterDelay",
+  "diffEditor.wordWrap": "on",
+  "terminal.integrated.defaultProfile.windows": "Git Bash",
+  "terminal.integrated.scrollback": 100000,
+  "editor.bracketPairColorization.enabled": true,
+  "prettier.bracketSameLine": true,
+  "editor.detectIndentation": false,
+  "diffEditor.ignoreTrimWhitespace": false,
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
+  "emmet.includeLanguages": {
+    "javascript": "javascriptreact"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Aykut Saki
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Aykut Saki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -21,15 +21,22 @@ yarn add epic-free-games
 ## Usage
 
 ```js
-const { getGames } = require("epic-free-games");
+const { EpicFreeGames } = require('epic-free-games');
 
 // OR
 
-import { getGames } from "epic-free-games";
+import { EpicFreeGames } from 'epic-free-games';
 
+const epicFreeGames = new EpicFreeGames({ country: 'JP', locale: 'ja', includeAll: true })
 
+epicFreeGames.getGames().then(res => {
+  // Do something
+}).catch(err => {
+  // Do something
+});
 
-getGames("JP", true).then(res => {
+// you can override default options
+epicFreeGames.getGames({ country: 'DE', locale: 'de', includeAll: false }).then(res => {
   // Do something
 }).catch(err => {
   // Do something
@@ -41,7 +48,8 @@ getGames("JP", true).then(res => {
 
 | Function    | Parameter             | Parameter Values                                                                               | Default Value  |
 | :---------: | :-------------------: | :--------------------------------------------------------------------------------------------: | :------------: |
-| getGames    | country: `string`     | "TR", "US", "GB", "DE", "AR", "ES", "MX", "FR", "IT", "JP", "KR", "PL", "BR", "RU", "TH", "CN", "IN", "GR | "US"           |
+| getGames    | country: `string`     | "TR", "US", "GB", "DE", "AR", "ES", "MX", "FR", "IT", "JP", "KR", "PL", "BR", "RU", "TH", "CN", "IN", "GR" | "US"           |
+| getGames    | locale: `string`      | "tr", "ja", "ar", "de", "en-US", "es-ES", "es-MX", "fr", "it", "ko", "pl", "pt-BR", "ru", "th", "zh-CN", "zh-Hant" | "en-US"           |
 | getGames    | includeAll: `boolean` | true \| false                                                                                  | false          |
 
 ## Sample Output