From d6fe0c6e56d210c1889e42018a2746ea7af48828 Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Tue, 22 Oct 2024 22:21:08 -0300 Subject: [PATCH] Post-release tweaks --- README.md | 21 ++++++++++++--------- package.json | 1 + share/Quran/examples/1_Quran_locales.mjs | 2 +- share/Quran/examples/2_Quran_surahs.mjs | 2 +- 4 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16c9394..f39f4a3 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 9d07f69..4004d94 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/share/Quran/examples/1_Quran_locales.mjs b/share/Quran/examples/1_Quran_locales.mjs index ec346e2..ee24183 100644 --- a/share/Quran/examples/1_Quran_locales.mjs +++ b/share/Quran/examples/1_Quran_locales.mjs @@ -1,5 +1,5 @@ #!/usr/bin/env node -import { Quran } from "@0x1eef/Quran"; +import { Quran } from "@0x1eef/quran"; (() => { const locales = Object.keys(Quran.locales) diff --git a/share/Quran/examples/2_Quran_surahs.mjs b/share/Quran/examples/2_Quran_surahs.mjs index eb89d30..3630edf 100644 --- a/share/Quran/examples/2_Quran_surahs.mjs +++ b/share/Quran/examples/2_Quran_surahs.mjs @@ -1,5 +1,5 @@ #!/usr/bin/env node -import { Quran } from "@0x1eef/Quran"; +import { Quran } from "@0x1eef/quran"; (() => { const surah = Quran.surahs["en"][0];