From 27f0cea28207dee70c5c0ad5953016db3b7be086 Mon Sep 17 00:00:00 2001 From: Siddharth VP Date: Fri, 19 Jan 2024 16:03:46 +0530 Subject: [PATCH] Update README --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ca30a1d..e429444 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ [![NPM version](https://img.shields.io/npm/v/types-mediawiki.svg)](https://www.npmjs.com/package/types-mediawiki) ![Linter](https://github.com/wikimedia-gadgets/types-mediawiki/workflows/Lint/badge.svg) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) # types-mediawiki TypeScript definitions for MediaWiki JS interface. -This package covers the functions and classes in the `mw` global object, as well a few jQuery plugins used in MediaWiki core. All commonly used parts of the interface are covered but as far as complete coverage is concerned, this is a work in progress. +This package covers the functions and classes in the `mw` global object, as well some jQuery plugins used in MediaWiki core. All commonly used parts of the interface are covered. + +[`@types/jquery`](https://www.npmjs.com/package/@types/jquery) and [`@types/oojs-ui`](https://www.npmjs.com/package/@types/oojs-ui) from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) are included as dependencies, so you don't need to install them separately. [![Download stats](https://nodei.co/npm/types-mediawiki.png?downloads=true&downloadRank=true)](https://nodei.co/npm/types-mediawiki/) @@ -25,7 +28,7 @@ Edit your project's `tsconfig.json` file so that it includes ] ``` -You should be all set! `mw` will be available in the global scope. There is no need to put any import statements in the TypeScript source files. This package includes [@types/jquery](https://www.npmjs.com/package/@types/jquery) as a dependency, so you don't need to install that separately. +You should be all set! `mw` will be available in the global scope. There is no need to put any import statements in the TypeScript source files. **If you find any errors or have suggestions for more specific typings, please open a PR or file an issue.** @@ -56,11 +59,3 @@ import type { ApiEditPageParams, ApiParseParams } from "types-mediawiki/api_para Since it is just a type import, it doesn't generate any JavaScript. Hence, such imports can also be used in non-modular applications. -## Types for OOjs & OOUI -TypeScript definitions of OOjs and OOUI is available on [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) and npm as [`@types/oojs`](https://www.npmjs.com/package/@types/oojs) and [`@types/oojs-ui`](https://www.npmjs.com/package/@types/oojs-ui) packages. - -## TODO -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) - -- Add doc comments for `mw.Title`, `mw.Uri`, `mw.storage`, `mw.language` and `mw.loader`. -- Add types for more jQuery plugins.