@pinta365/blizzard_api 0.3.5 → 0.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,10 +1,13 @@
1
- # BLIZZARD_API
1
+ # BLIZZARD API
2
2
 
3
3
  [![JSR Version](https://jsr.io/badges/@pinta365/blizzard-api)](https://jsr.io/@pinta365/blizzard-api)
4
4
 
5
5
  Start of what will cover the whole Blizzard Battle.net API when its done.
6
6
 
7
- Link to the module on [JSR](https://jsr.io/@pinta365/blizzard-api)
7
+ Available as:
8
+
9
+ - ESM module: [JSR](https://jsr.io/@pinta365/blizzard-api)
10
+ - CommonJS module: [NPM](https://www.npmjs.com/package/@pinta365/blizzard_api)
8
11
 
9
12
  ## WORK IN PROGRESS
10
13
 
@@ -28,7 +31,25 @@ to implement authorization code flow also.
28
31
  | **StarCraft II:** Community APIs | | |
29
32
  | **StarCraft II:** Game Data APIs | ✅ | |
30
33
 
31
- ## Example
34
+ ## ⚡️ Quickstart
35
+
36
+ **Installation**
37
+
38
+ ```bash
39
+ # Deno
40
+ deno add @pinta365/blizzard-api
41
+
42
+ # Bun
43
+ bunx jsr add @pinta365/blizzard-api
44
+
45
+ # Node.js
46
+ npx jsr add @pinta365/blizzard-api
47
+
48
+ # NPM (CommonJS)
49
+ npm install @pinta365/blizzard_api --save
50
+ ```
51
+
52
+ **Basic Usage (ESM)**
32
53
 
33
54
  ```javascript
34
55
  import * as blizzardAPI from "@pinta365/blizzard-api";
@@ -43,12 +64,16 @@ blizzardAPI.setup({
43
64
  locale: "en_GB",
44
65
  });
45
66
 
46
- try {
47
- const sword = await blizzardAPI.wow.item(33791);
48
- console.log(sword);
49
- } catch (error) {
50
- console.log(error);
51
- }
67
+ const sword = await blizzardAPI.wow.item(33791);
68
+ console.log(sword);
69
+ ```
70
+
71
+ **Basic Usage (CommonJS)**
72
+
73
+ ```javascript
74
+ const blizzardAPI = require("@pinta365/blizzard_api");
75
+
76
+ // Use blizzardAPI the same way as in the previous example.
52
77
  ```
53
78
 
54
79
  ## Issues
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pinta365/blizzard_api",
3
- "version": "0.3.5",
3
+ "version": "0.3.6",
4
4
  "description": "TS library to interact with the Blizzard Battle.net API. World of Warcraft, World of Warcraft Classic, StarCraft 2, Diablo 3, Hearthstone.",
5
5
  "keywords": [
6
6
  "blizzard",