@quranjs/api 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
# @quranjs/api
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
[![Build Status][build-badge]][build]
|
|
8
|
+
[![MIT License][license-badge]][license]
|
|
9
|
+
[![NPM Version][npm-badge]][npm]
|
|
10
|
+
[![NPM Monthly downloads][downloads-badge]][npm]
|
|
11
|
+
[![Minziped Size][size-badge]][npm]
|
|
12
|
+
|
|
13
|
+
A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.
|
|
8
14
|
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
@@ -19,3 +25,15 @@ using yarn:
|
|
|
19
25
|
```ssh
|
|
20
26
|
yarn add @quranjs/api
|
|
21
27
|
```
|
|
28
|
+
|
|
29
|
+
<!-- Links -->
|
|
30
|
+
|
|
31
|
+
[qdc-api]: https://quran.api-docs.io/
|
|
32
|
+
[build-badge]: https://img.shields.io/github/workflow/status/quranjs/api/CI?logo=github&style=flat-square
|
|
33
|
+
[build]: https://github.com/quranjs/api/actions?query=workflow%3ACI
|
|
34
|
+
[license-badge]: https://img.shields.io/github/license/quranjs/api?style=flat-square
|
|
35
|
+
[license]: https://github.com/quranjs/api/blob/master/LICENSE
|
|
36
|
+
[npm]: https://www.npmjs.com/package/@quranjs/api
|
|
37
|
+
[npm-badge]: https://img.shields.io/npm/v/@quranjs/api.svg?style=flat-square
|
|
38
|
+
[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg?style=flat-square
|
|
39
|
+
[size-badge]: https://img.shields.io/bundlephobia/minzip/@quranjs/api/latest.svg?style=flat-square
|