-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitBook as the primary documentation source (#20)
* GitBook: [docs/gitbook] 2 pages modified * GitBook: [docs/gitbook] 2 pages modified * GitBook: [docs/gitbook] one page modified * GitBook: [docs/gitbook] 2 pages modified * GitBook: [docs/gitbook] 10 pages modified * GitBook: [docs/gitbook] 2 pages modified * GitBook: [docs/gitbook] 8 pages modified * GitBook: [docs/gitbook] 8 pages modified * GitBook: [docs/gitbook] 9 pages modified * GitBook: [docs/gitbook] 8 pages modified * GitBook: [docs/gitbook] 8 pages modified * GitBook: [docs/gitbook] one page modified * GitBook: [docs/gitbook] one page modified * GitBook: [docs/gitbook] 5 pages modified * GitBook: [docs/gitbook] 8 pages modified * GitBook: [docs/gitbook] 5 pages modified
- Loading branch information
Austin Paquette
committed
Feb 19, 2020
1 parent
c7f497a
commit 985d562
Showing
11 changed files
with
37 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,12 @@ | ||
<h1 align="center"> | ||
(Unofficial) RuneScape API Client | ||
</h1> | ||
# Introduction | ||
|
||
<p align="center"> | ||
<a href="https://github.com/pqt/runescape-api/actions?workflow=status"> | ||
<img src="https://github.com/pqt/runescape-api/workflows/status/badge.svg?color=005cc5" alt="Current Github Action build status." /> | ||
</a> | ||
<a href="https://www.npmjs.org/package/runescape-api"> | ||
<img src="https://img.shields.io/librariesio/release/npm/runescape-api" alt="Package dependancy status." /> | ||
</a> | ||
<a href="https://www.npmjs.org/package/runescape-api"> | ||
<img src="https://img.shields.io/npm/dt/runescape-api?color=005cc5" alt="Total downloads." /> | ||
</a> | ||
<a href="https://www.npmjs.org/package/runescape-api"> | ||
<img src="https://img.shields.io/npm/v/runescape-api.svg?color=005cc5" alt="npm package version." /> | ||
</a> | ||
<a href="https://github.com/pqt/runescape-api/blob/master/LICENSE"> | ||
<img src="https://img.shields.io/badge/license-MIT-blue.svg?color=005cc5" alt="Released under the MIT license." /> | ||
</a> | ||
</p> | ||
[![Current Github Action build status.](https://github.com/pqt/runescape-api/workflows/status/badge.svg?color=005cc5)](https://github.com/pqt/runescape-api/actions?workflow=status) [![Package dependancy status.](https://img.shields.io/librariesio/release/npm/runescape-api)](https://www.npmjs.org/package/runescape-api) [![Total downloads.](https://img.shields.io/npm/dt/runescape-api?color=005cc5)](https://www.npmjs.org/package/runescape-api) [![npm package version.](https://img.shields.io/npm/v/runescape-api.svg?color=005cc5)](https://www.npmjs.org/package/runescape-api) [![Released under the MIT license.](https://img.shields.io/badge/license-MIT-blue.svg?color=005cc5)](https://github.com/pqt/runescape-api/blob/master/LICENSE) | ||
|
||
# Installation | ||
## Installation | ||
|
||
```bash | ||
npm install runescape-api | ||
# OR | ||
yarn add runescape-api | ||
``` | ||
|
||
# Documentation | ||
|
||
Checkout the [Gitbook Documentation](https://pqt.gitbook.io/runescape-api/) for more details about each of the available methods. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Table of contents | ||
|
||
* [Introduction](README.md) | ||
|
||
## Documentation <a id="docs"></a> | ||
|
||
* [Bestiary](docs/introduction.md) | ||
* [Clan](docs/clan.md) | ||
* [Grand Exchange](docs/grandexchange.md) | ||
* [Hiscores](docs/hiscores.md) | ||
* [Miscellaneous](docs/miscellaneous.md) | ||
* [RuneMetrics](docs/runemetrics.md) | ||
* [Oldschool](docs/osrs/README.md) | ||
* [OSRS Grand Exchange](docs/osrs/grandexchange.md) | ||
* [OSRS Hiscores](docs/osrs/hiscores.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Clan | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Grand Exchange | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Hiscores | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Bestiary | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Miscellaneous | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Oldschool | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# OSRS Grand Exchange | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# OSRS Hiscores | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# RuneMetrics | ||
|