guildwars2-ts 1.0.2 → 1.0.3

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 (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +24 -8
  3. package/package.json +4 -1
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  ISC License
2
2
 
3
- Copyright (c) 2022 Ivan Sosnov
3
+ Copyright (c) 2023 Ivan Sosnov
4
4
  Copyright (c) 2021 Julio Sansossio (parts of request base code)
5
5
 
6
6
  Permission to use, copy, modify, and/or distribute this software for any
package/README.md CHANGED
@@ -1,12 +1,13 @@
1
- # Typescript API Wrapper for Guild Wars 2
1
+ # Typescript API Wrapper for GuildWars 2
2
2
 
3
- ## Plans
4
- - Conditional type validation for several endpoints
5
- - Data caching for repeated requests
6
- - Better logging
7
- - Support for different schemas, when available
3
+ [![NPM version][npm-image]][npm-link]
4
+ [![License][license]][LICENSE]
8
5
 
9
- ## Available Endpoints (Guild Wars 2)
6
+ This project is a third-party package, and is strictly not affiliated with GuildWars2, ArenaNet, or NCSoft.
7
+
8
+ When used, no data is saved by, or sent to the developers, including but not limited to the logs, api tokens, or any objects returned by the endpoints.
9
+
10
+ ## Available Endpoints (GuildWars 2)
10
11
 
11
12
  Full support of all endpoints listed in the [API:2 Wiki](https://wiki.guildwars2.com/wiki/API:2) page
12
13
 
@@ -36,4 +37,19 @@ const api: GW2Api = new GW2Api({
36
37
  });
37
38
  });
38
39
  })();
39
- ```
40
+ ```
41
+
42
+ ## Contibutions
43
+
44
+ If you find any kinds of errors in the program code, or wish to add/update any of the functionality provided by this project, please feel free to open a pull request. Validation error logs are extremely helpful, so please include them in the request
45
+
46
+ ## Plans
47
+ - Conditional type validation for several endpoints - [Work in progress](https://gitlab.com/dinckelman/guildwars2-ts/-/tree/validation)
48
+ - Data caching for repeated requests
49
+ - Better logging
50
+ - Support for different schemas, when available
51
+
52
+ [npm-image]: https://img.shields.io/npm/v/guildwars2-ts
53
+ [npm-link]: https://www.npmjs.com/package/guildwars2-ts
54
+ [license]: https://img.shields.io/gitlab/license/dinckelman%2Fguildwars2-ts
55
+
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "guildwars2-ts",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "GuildWars 2 API Wrapper in Typescript",
5
+ "homepage": "https://gitlab.com/dinckelman/guildwars2-ts",
5
6
  "main": "dist/index.js",
6
7
  "module": "dist/index.mjs",
7
8
  "types": "dist/index.d.ts",
@@ -19,6 +20,8 @@
19
20
  "keywords": [
20
21
  "guildwars",
21
22
  "guildwars2",
23
+ "guild wars",
24
+ "guild wars 2",
22
25
  "gw",
23
26
  "gw2"
24
27
  ],