Skip to content

Commit

Permalink
feat: add badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmedriad1 committed Mar 28, 2022
1 parent 709f92e commit 29c0a01
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@

# @quranjs/api

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.
[![Build Status][build-badge]][build]
[![MIT License][license-badge]][license]
[![NPM Version][npm-badge]][npm]
[![NPM Monthly downloads][downloads-badge]][npm]
[![Minziped Size][size-badge]][npm]

A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.

## Installation

Expand All @@ -19,3 +25,15 @@ using yarn:
```ssh
yarn add @quranjs/api
```

<!-- Links -->

[qdc-api]: https://quran.api-docs.io/
[build-badge]: https://img.shields.io/github/workflow/status/quranjs/api/CI?logo=github&style=flat-square
[build]: https://github.com/quranjs/api/actions?query=workflow%3ACI
[license-badge]: https://img.shields.io/github/license/quranjs/api?style=flat-square
[license]: https://github.com/quranjs/api/blob/master/LICENSE
[npm]: https://www.npmjs.com/package/@quranjs/api
[npm-badge]: https://img.shields.io/npm/v/@quranjs/api.svg?style=flat-square
[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg?style=flat-square
[size-badge]: https://img.shields.io/bundlephobia/minzip/@quranjs/api/latest.svg?style=flat-square

0 comments on commit 29c0a01

Please sign in to comment.