@quranjs/api 1.8.0 → 2.0.1

package/README.md

@@ -1,41 +1,81 @@
-![Quranjs Api Header](https://github.com/quran/api-js/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.
+# @quranjs/api
 
-[Checkout Docs][docs]
-
-[![Build Status][build-badge]][build]
-[![MIT License][license-badge]][license]
 [![NPM Version][npm-badge]][npm]
-[![Minziped Size][size-badge]][npm]
+[![MIT License][license-badge]][license]
+[![Build Status][build-badge]][build]
 [![NPM Monthly downloads][downloads-badge]][npm]
 
-## Installation
+A JavaScript/TypeScript library for fetching **authentic, scholarly verified Quran data** from the [Quran.com API](https://api-docs.quran.foundation/docs/category/content-apis).
+
+Unlike other sources, this SDK connects you directly to the **[Quran Foundation](https://quran.foundation)**—ensuring a **trusted, highly scrutinized source** of reliable content, including properly licensed translations, tafsir, and supplementary materials.
 
-using npm:
+Works seamlessly in both Node.js and browser environments.
 
-```ssh
+**Built by the [Quran Foundation](https://quran.foundation) — the team behind [Quran.com](https://quran.com)**
+
+## Installation
+
+```bash
+# npm
 npm install @quranjs/api
+
+# yarn
+yarn add @quranjs/api
+
+# pnpm
+pnpm add @quranjs/api
 ```
 
-using yarn:
+## Quick Start
 
-```ssh
-yarn add @quranjs/api
+```typescript
+import { quran } from '@quranjs/api';
+
+// Get all chapters
+const chapters = await quran.v4.chapters.findAll();
+
+// Get a specific chapter
+const surah = await quran.v4.chapters.findById(1);
+
+// Get verses of a chapter
+const verses = await quran.v4.verses.findByChapter(1);
+
+// Search the Quran
+const results = await quran.v4.search.search('mercy');
 ```
 
-## Getting Started
+## Documentation
+
+For complete documentation, guides, and API reference, visit:
+
+📚 **[SDK Documentation](https://api-docs.quran.foundation/docs/sdk/javascript)**
+
+## Features
 
-you can visit the [docs][docs] for more details.
+- 🚀 Full TypeScript support
+- 🌐 Works in Node.js and browsers
+- ✅ Scholarly verified data
+- 📖 Access chapters, verses, juzs, and more
+- 🔍 Full-text search
+- 🎧 Audio recitations
+- 🌍 Multiple verified translations and languages
+
+## Links
+
+- [Quran Foundation](https://quran.foundation) — Our mission to make the Quran accessible to everyone
+- [API Documentation](https://api-docs.quran.foundation) — Full API reference
+- [GitHub Repository](https://github.com/quran/api-js) — Source code and issues
+
+## License
+
+MIT © [Quran Foundation](https://quran.foundation)
 
 <!-- Links -->
 
-[qdc-api]: https://api-docs.quran.com/docs/quran.com_versioned/4.0.0/quran-com-api
-[docs]: https://quranjs.com/
+[npm]: https://www.npmjs.com/package/@quranjs/api
+[npm-badge]: https://img.shields.io/npm/v/@quranjs/api
+[license-badge]: https://img.shields.io/npm/l/@quranjs/api
+[license]: https://github.com/quran/api-js/blob/main/LICENSE
 [build-badge]: https://github.com/quran/api-js/workflows/CI/badge.svg
 [build]: https://github.com/quran/api-js/actions?query=workflow%3ACI
-[license-badge]: https://badgen.net/github/license/quranjs/api
-[license]: https://github.com/quran/api-js/blob/master/LICENSE
-[npm]: https://www.npmjs.com/package/@quranjs/api
-[npm-badge]: https://badgen.net/npm/v/@quranjs/api
-[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg
-[size-badge]: https://badgen.net/packagephobia/publish/@quranjs/api
+[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api