Updated documents

Signed-off-by: Avior <florian.bouillon@delta-wings.net>

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 2.3.0 - 2021-06-22
+
+### Added
+
+- Browser specialized build
+- [#9](https://github.com/tcgdex/javascript-sdk/pull/9) Build/Unit/ESLint tests and coverage with Codecov using Github Action
+
+### Changed
+
+- [#10](https://github.com/tcgdex/javascript-sdk/pull/10) Simplified Request/Cache manager
+
 ## [2.2.0] - 2021-06-19
 
 ### Added
@@ -55,10 +66,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Functions now use `fetch` instead of `get` in their names
 - URL Normalization is now done by the SDK
 
-### Fixed
-
-- `getSerie(s)` now point to the correct endpoint
-
 ### Removed
 
 - TranslationUtil as now translation are managed by the API
@@ -186,8 +193,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Constructor arg support for multiple langs
 - TranslationUtil to go from the SDK value to a text value
 
-[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.1.1...HEAD
+[Unreleased]: https://github.com/tcgdex/javascript-sdk/compare/v2.3.0...HEAD
 
+[2.3.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.3.0
+[2.2.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.2.0
 [2.1.1]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.1
 [2.1.0]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.1.0
 [2.0.2-2.0.3]: https://github.com/tcgdex/javascript-sdk/releases/tag/v2.0.3

README.md

@@ -1,11 +1,31 @@
+<p align="center">
+	<a href="http://npmjs.com/@tcgdex/sdk">
+		<img src="https://img.shields.io/npm/v/@tcgdex/sdk?style=flat-square" alt="NOM Version">
+	</a>
+	<a href="http://npmjs.com/@tcgdex/sdk">
+		<img src="https://img.shields.io/npm/dw/@tcgdex/sdk?style=flat-square" alt="NPM Downloads">
+	</a>
+	<a href="https://app.codecov.io/gh/tcgdex/javascript-sdk/">
+		<img src="https://img.shields.io/codecov/c/github/tcgdex/javascript-sdk?style=flat-square&token=FR4BI94N4Q" alt="npm version">
+	</a>
+	<a href="https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md">
+		<img src="https://img.shields.io/github/license/tcgdex/javascript-sdk?style=flat-square" alt="the TCGdex JAvascript SDK is released under the MIT license." />
+	</a>
+	<a href="https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md">
+		<img src="https://img.shields.io/github/workflow/status/tcgdex/javascript-sdk/Build%20&%20Test?style=flat-square" alt="the TCGdex JAvascript SDK is released under the MIT license." />
+	</a>
+
+</p>
+
 # TCGdex JavaScript/TypeScript SDK
 
-This is the SDK used to communicate with the Open source [TCGdex API](https://www.github.com/tcgdex/cards-database)
+Communicate with the Open Source TCGdex API in Javascript/Typescript using the SDK
 
 Full API/SDK documentation in progress at https://www.tcgdex.net/docs
 
-## Install
+## Getting Started
 
+Install the SDK using:
 ```bash
 yarn add @tcgdex/sdk
 # or
@@ -20,7 +40,7 @@ _Note: a complete documentation is in progress_
 import TCGdex from '@tcgdex/sdk'
 
 // initialize the SDK
-const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.d.ts line 1 for supported languages)
+const tcgdex = new TCGdex('en') // Lang code (Optionnal) (See interfaces.ts line 1 for supported languages)
 
 // if you need to change the language
 tcgdex.lang = 'fr'

package.json

@@ -4,6 +4,20 @@
 	"main": "./dist/cjs/tcgdex.node.js",
 	"types": "./dist/types/tcgdex.d.ts",
 	"repository": "https://github.com/tcgdex/javascript-sdk.git",
+	"homepage": "https://github.com/tcgdex/javascript-sdk",
+	"author": "Aviortheking",
+	"keywords": [
+		"tcgdex",
+		"pokemon",
+		"trading",
+		"card",
+		"tcg",
+		"sdk",
+		"api",
+		"typescript",
+		"javascript",
+		"typing"
+	],
 	"license": "MIT",
 	"devDependencies": {
 		"@babel/core": "^7.14.6",