ReflectsLight/Quran.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Post-release tweaks

Browse source
This commit is contained in:
0x1eef 2024-10-22 22:21:08 -03:00
parent a0d88ffb90
commit d6fe0c6e56
4 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,9 +1,9 @@
## About
This repository provides a programmer's interface
to The Noble Quran, alongside various translations.
At the time of writing there is support for the Arabic,
English, and Farsi languages.
[`@0x1eef/quran`](https://www.npmjs.com/package/@0x1eef/quran)
provides a programmer's interface to The Noble Quran,
alongside various translations. At the time of writing
there is support for the Arabic, English, and Farsi languages.
## Examples
@ -12,11 +12,13 @@ English, and Farsi languages.
The `Quran.locales` method provides an object where the
key is a locale name (such as `en`) and the value is a
locale object. The locales returned by this method indicate
what languages the `@0x1eef/Quran` library supports:
what languages the
[`@0x1eef/quran`](https://www.npmjs.com/package/@0x1eef/quran)
library supports:
```typescript
#!/usr/bin/env node
import { Quran } from "@0x1eef/Quran";
import { Quran } from "@0x1eef/quran";
(() => {
const locales = Object.keys(Quran.locales);
@ -40,7 +42,7 @@ object. For example:
```typescript
#!/usr/bin/env node
import { Quran } from "@0x1eef/Quran";
import { Quran } from "@0x1eef/quran";
(() => {
const surah = Quran.surahs["en"][0];
@ -55,9 +57,10 @@ import { Quran } from "@0x1eef/Quran";
## Install
`@0x1eef/Quran` is available via npm:
[`@0x1eef/quran`](https://www.npmjs.com/package/@0x1eef/quran)
is available via npm:
npm i @0x1eef/Quran
npm i @0x1eef/quran
## Thanks

1
package.json
View file

@ -9,6 +9,7 @@
"exports": {".": "./dist/index.mjs"},
"files": ["README.md", "package.json", "share/*", "share/**/*", "dist/*", "dist/**/*"],
"keywords": ["quran", "islam", "typescript", "javascript"],
"publishConfig": { "access": "public" },
"scripts": {
"build": "npx webpack --config etc/webpack.config.js",
"prepare": "npm run build && npm run tsc:decl",

2
share/Quran/examples/1_Quran_locales.mjs
View file

@ -1,5 +1,5 @@
#!/usr/bin/env node
import { Quran } from "@0x1eef/Quran";
import { Quran } from "@0x1eef/quran";
(() => {
const locales = Object.keys(Quran.locales)

2
share/Quran/examples/2_Quran_surahs.mjs
View file

@ -1,5 +1,5 @@
#!/usr/bin/env node
import { Quran } from "@0x1eef/Quran";
import { Quran } from "@0x1eef/quran";
(() => {
const surah = Quran.surahs["en"][0];