Skip to content

Commit 29c0a01

Browse files
committed
feat: add badges to README
1 parent 709f92e commit 29c0a01

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@
44

55
# @quranjs/api
66

7-
A library for fetching quran data from the [quran.com API](https://quran.api-docs.io/). This library also works on both Node.js and the browser.
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.
814

915
## Installation
1016

@@ -19,3 +25,15 @@ using yarn:
1925
```ssh
2026
yarn add @quranjs/api
2127
```
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

0 commit comments

Comments
 (0)