Skip to content

Commit

Permalink
Switch versioning to v1: public interface is stable
Browse files Browse the repository at this point in the history
And has been for quite a while now
  • Loading branch information
siddharthvp committed Aug 29, 2021
1 parent 79b49a7 commit 04e2b23
Show file tree
Hide file tree
Showing 6 changed files with 600 additions and 699 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@

Mwn works with both JavaScript and TypeScript. It is created with a design philosophy of allowing bot developers to easily and quickly write bot code, without having to deal with the MediaWiki API complications and idiosyncrasies such as logins, tokens, maxlag, query continuations and error handling. [Making raw API calls](https://mwn.toolforge.org/docs/direct-api-calls) is also supported for complete flexibility where needed. Mwn uses [JSON with formatversion 2](https://www.mediawiki.org/wiki/API:JSON_version_2#Using_the_new_JSON_results_format) by default. The [axios](https://www.npmjs.com/package/axios) library is used for HTTP requests.

Versioning: while mwn is in version 0, changes may be made to the public interface with a change in the minor version number.

In addition to the MediaWiki Action API, the library also provides methods to talk to the Wikimedia EventStreams API, the ORES API, Pageviews API and WikiWho API.

This library uses mocha for tests and has extensive test coverage covering all commonly used code paths. Testing is automated using a CI workflow on Github Actions.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mwn",
"version": "0.11.2",
"version": "1.11.3",
"description": "JavaScript & TypeScript MediaWiki bot framework for Node.js",
"main": "./build/bot.js",
"types": "./build/bot.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion website/docs/14-developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Obtain the latest development copy:

```sh
```bash
git clone https://github.com/siddharthvp/mwn.git
cd mwn
npm install # install dependencies
Expand Down
Loading

0 comments on commit 04e2b23

Please sign in to comment.