Skip to content

Commit b8b3804

Browse files
committed
Bump version & update README with contribution information
1 parent 2fe60ef commit b8b3804

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
[![npm version](https://badge.fury.io/js/mcm-js-api-wrapper.svg)](https://www.npmjs.com/package/mcm-js-api-wrapper)
55
[![npm version](https://img.shields.io/badge/docs-passing-brightgreen)](https://mc-market-org.github.io/js-api-wrapper/)
66

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/).
88

99
- Fully asynchronous design compatible with .then() notation or async/await.
1010
- 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.
1314

1415
## Installation & Basic Usage
1516

@@ -39,17 +40,27 @@ Initialise wrapper and fetch information about yourself via async/await:
3940

4041
```JS
4142
const { Wrapper, Token, TokenType } = require("mcm-js-api-wrapper");
42-
...
4343

4444
let token = new Token(TokenType.PRIVATE, "Find @ https://www.mc-market.org/account/api");
4545
let wrapper = new Wrapper();
46+
...
4647

4748
// Let the caller catch any Promise rejections. Else, use a try-catch block.
4849
await wrapper.init(token);
4950
console.log(await wrapper.members().self());
5051
```
5152

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.
5364

5465
## Issues & Support
5566

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mcm-js-api-wrapper",
3-
"version": "1.0.2",
3+
"version": "1.1.0",
44
"description": "An official asynchronous JavaScript (Node.js) wrapper for MC-Market's Ultimate REST API.",
55
"main": "./src/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)