Kalakoi/osrs-json-hiscores
1
0
Fork 0
mirror of https://github.com/maxswa/osrs-json-hiscores.git synced 2025-10-15 10:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add types badge

Browse Source
This commit is contained in:
Max
2019-06-15 15:26:19 -04:00
parent 4d0fd81a91
commit cf67d38207
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -1,7 +1,8 @@
# OSRS .json Hiscores # OSRS .json Hiscores
[![npm](https://img.shields.io/npm/v/osrs-json-hiscores.svg?style=flat-square)](https://www.npmjs.com/package/osrs-json-hiscores) [![npm](https://img.shields.io/npm/v/osrs-json-hiscores.svg?style=flat-square)](https://www.npmjs.com/package/osrs-json-hiscores)
[![npm](https://img.shields.io/npm/dm/osrs-json-hiscores.svg?style=flat-square)](https://npm-stat.com/charts.html?package=osrs-json-hiscores) [![downloads](https://img.shields.io/npm/dm/osrs-json-hiscores.svg?style=flat-square)](https://npm-stat.com/charts.html?package=osrs-json-hiscores)
[![types](https://img.shields.io/npm/types/osrs-json-hiscores.svg?style=flat-square)](https://github.com/maxswa/osrs-json-hiscores/src/types.ts)
**The Oldschool Runescape API wrapper that does more!** **The Oldschool Runescape API wrapper that does more!**
@@ -12,7 +13,7 @@ This wrapper converts it to json and provides extra information about the given
Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json. Additional functions are provided that screen-scrape the OSRS leaderboards and return a list of players as json.
`osrs-json-hiscores` has Typescript support, with full definitions for all functions and custom data types. `osrs-json-hiscores` has TypeScript support, with full definitions for all functions and custom data types.
## Installation ## Installation
@@ -45,7 +46,7 @@ hiscores
.catch(err => console.error(err)); .catch(err => console.error(err));
``` ```
If you are using Typescript or transpiling your JS you can use ES6 syntax: If you are using TypeScript or transpiling your JS you can use ES6 syntax:
```javascript ```javascript
import hiscores, { getSkillPage } from 'osrs-json-hiscores'; import hiscores, { getSkillPage } from 'osrs-json-hiscores';