Skip to content

Commit

Permalink
feat(docs): add docs url in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmedriad1 committed Mar 30, 2022
1 parent 56e592c commit e0ed086
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
![Quranjs Api Header](https://github.com/quranjs/api/raw/master/media/repo-header.png)
A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.

[Checkout Docs][docs]

[![Build Status][build-badge]][build]
[![MIT License][license-badge]][license]
[![NPM Version][npm-badge]][npm]
Expand All @@ -21,9 +23,14 @@ using yarn:
yarn add @quranjs/api
```

## Getting Started

you can visit the [docs][docs] for more details.

<!-- Links -->

[qdc-api]: https://quran.api-docs.io/
[docs]: https://quranjs.vercel.app/
[build-badge]: https://github.com/quranjs/api/workflows/CI/badge.svg
[build]: https://github.com/quranjs/api/actions?query=workflow%3ACI
[license-badge]: https://badgen.net/github/license/quranjs/api
Expand Down

2 comments on commit e0ed086

@vercel
Copy link

@vercel vercel bot commented on e0ed086 Mar 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

quranjs-docs – ./docs

quranjs-docs-ahmed-riad.vercel.app
quranjs-docs-git-master-ahmed-riad.vercel.app
quranjs-docs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on e0ed086 Mar 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

api – ./docs

api-quranjs.vercel.app
quranjs.vercel.app
api-git-master-quranjs.vercel.app

Please sign in to comment.