<commit_before>
<p align="center">
    <img src="https://user-images.githubusercontent.com/5665498/147855777-fc7d645c-6522-4bb3-8886-32c9f90b20df.png" width="350pt">
</p>

QuranEngine is the engine powering the [Quran.com iOS app](https://itunes.apple.com/app/id1118663303). It's a collection of libraries that can be used to create a Quran app or a quran reading/listening experience within an Islamic app.

- [Libraries](#libraries)
  - [QuranKit](#qurankit)
  - [QuranTextKit](#qurantextkit)
- [Libraries to Open Source Soon](#libraries-to-open-source-soon)
  - [QuranMadaniData](#quranmadanidata)
  - [QuranAudioKit](#quranaudiokit)
  - [QuranBookmarkingKit](#quranbookmarkingkit)
- [Installation](#installation)
  - [Swift Package Manager](#swift-package-manager)
- [Contributions](#contributions)
- [License](#license)

## Libraries

We have currently open sourced the following libraries:

### QuranKit
A quranic numbering library. It can be used to locate the page of a verse or juz' of a page, etc.

### QuranTextKit
A quranic text kit to search and retrieve quran, translations and tafseers text.


## Libraries to Open Source Soon

The following are libraries we are going to open source soon.

### QuranMadaniData

The data for the madani Quran.

### QuranAudioKit

A library for downloading and playing quran recitations.

### QuranBookmarkingKit

A library for taking bookmarks and notes.


## Installation

### Swift Package Manager

```swift
let package = Package(
    name: "<YOUR PACKAGE>",
    products: [
        .library(name: "<YOUR PACKAGE>", targets: ["Caching"]),
    ],
    dependencies: [
        .package(url: "https://github.com/quran/quran-ios", .from("2.0.0")),
    ],
    targets: [
        .target(<commit_msg>Update readme to use version 2.0.1<commit_after>
<p align="center">
    <img src="https://user-images.githubusercontent.com/5665498/147855777-fc7d645c-6522-4bb3-8886-32c9f90b20df.png" width="350pt">
</p>

QuranEngine is the engine powering the [Quran.com iOS app](https://itunes.apple.com/app/id1118663303). It's a collection of libraries that can be used to create a Quran app or a quran reading/listening experience within an Islamic app.

- [Libraries](#libraries)
  - [QuranKit](#qurankit)
  - [QuranTextKit](#qurantextkit)
- [Libraries to Open Source Soon](#libraries-to-open-source-soon)
  - [QuranMadaniData](#quranmadanidata)
  - [QuranAudioKit](#quranaudiokit)
  - [QuranBookmarkingKit](#quranbookmarkingkit)
- [Installation](#installation)
  - [Swift Package Manager](#swift-package-manager)
- [Contributions](#contributions)
- [License](#license)

## Libraries

We have currently open sourced the following libraries:

### QuranKit
A quranic numbering library. It can be used to locate the page of a verse or juz' of a page, etc.

### QuranTextKit
A quranic text kit to search and retrieve quran, translations and tafseers text.


## Libraries to Open Source Soon

The following are libraries we are going to open source soon.

### QuranMadaniData

The data for the madani Quran.

### QuranAudioKit

A library for downloading and playing quran recitations.

### QuranBookmarkingKit

A library for taking bookmarks and notes.


## Installation

### Swift Package Manager

```swift
let package = Package(
    name: "<YOUR PACKAGE>",
    products: [
        .library(name: "<YOUR PACKAGE>", targets: ["Caching"]),
    ],
    dependencies: [
        .package(url: "https://github.com/quran/quran-ios", .from("2.0.1")),
    ],
    targets: [
        .target(
{'fraction_non_alphanumeric': 0.12375249500998003, 'fraction_numerical': 0.031080695751354435, 'mean_word_length': 4.220238095238095, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2665055', 'n_tokens_mistral': 1298, 'n_tokens_neox': 1127, 'n_words': 332}