|
4 | 4 | [](https://www.npmjs.com/package/mcm-js-api-wrapper) |
5 | 5 | [](https://mc-market-org.github.io/js-api-wrapper/) |
6 | 6 |
|
7 | | -An official asynchronous JavaScript (Node.js) wrapper for MC-Market's [Ultimate REST API](https://www.mc-market.org/wiki/ultimate-api/). |
| 7 | +An official asynchronous Node.js wrapper for MC-Market's [Ultimate REST API](https://www.mc-market.org/wiki/ultimate-api/). |
8 | 8 |
|
9 | 9 | - Fully asynchronous design compatible with .then() notation or async/await. |
10 | 10 | - Dynamically stalls requests when a rate limit is hit. |
11 | | -- A comprehensive set of usage examples. |
12 | | -- Heavily commented making contributions painless. |
| 11 | +- Full coverage of the Ultimate API. |
| 12 | +- A comprehensive set of relevant usage examples. |
| 13 | +- Automatically generated and hosted documentation. |
13 | 14 |
|
14 | 15 | ## Installation & Basic Usage |
15 | 16 |
|
@@ -39,17 +40,27 @@ Initialise wrapper and fetch information about yourself via async/await: |
39 | 40 |
|
40 | 41 | ```JS |
41 | 42 | const { Wrapper, Token, TokenType } = require("mcm-js-api-wrapper"); |
42 | | -... |
43 | 43 |
|
44 | 44 | let token = new Token(TokenType.PRIVATE, "Find @ https://www.mc-market.org/account/api"); |
45 | 45 | let wrapper = new Wrapper(); |
| 46 | +... |
46 | 47 |
|
47 | 48 | // Let the caller catch any Promise rejections. Else, use a try-catch block. |
48 | 49 | await wrapper.init(token); |
49 | 50 | console.log(await wrapper.members().self()); |
50 | 51 | ``` |
51 | 52 |
|
52 | | -A full list of functions and their signatures can be found [here](https://github.com/MC-Market-org/mcm-js-api-wrapper/blob/main/USAGE.md). |
| 53 | +An comprehensive set of [examples](https://github.com/MC-Market-org/js-api-wrapper/tree/main/examples) can be found under the `/examples` directory. |
| 54 | + |
| 55 | +## Contributions |
| 56 | + |
| 57 | +We welcome contributions from our Ultimate members in the form of bug fixes or otherwise. All pull requests will be reviewed and changes may be requested before merging. Though, please seek advice regarding the introduction of additional features via an issue before working on them - we may have reasons not to introduce the given feature, or may want to introduce it via a different approach. |
| 58 | + |
| 59 | +Whilst no contribution guidelines exist currently, please ensure you: |
| 60 | +- Develop with readability in mind. |
| 61 | +- Comment appropriately where non-obvious approaches or invariants are being enforced. |
| 62 | +- Include documentation comments where appropriate. |
| 63 | +- Use `eslint` within your final commit. |
53 | 64 |
|
54 | 65 | ## Issues & Support |
55 | 66 |
|
|
0 commit comments