From 3bef4988dd6333dce52e2eeda7c35851b8aa0d1d Mon Sep 17 00:00:00 2001 From: MKSherbini Date: Wed, 12 Jun 2024 17:53:51 +0300 Subject: [PATCH] update readme and capitalize Quran --- README.md | 16 ++++++++++------ main.ts | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c500579..c449c29 100644 --- a/README.md +++ b/README.md @@ -14,22 +14,22 @@ After enabling the plugin in the settings menu, you should see the added command ## Features - commands: - - `Noor: Random quran quote`: inserts a quote block at the current editor location containing a random verse with recitation + - `Noor: Random Quran quote`: inserts a quote block at the current editor location containing a random verse with recitation - scripting: - `noorJS.randomQuranQuote()`: this function returns a quote block containing a random verse with recitation ## Integration with other plugins -obsidian plugins compliment each others, here are some ideas -- **with [templater](https://github.com/SilentVoid13/Templater)**: use `<% noorJS.randomQuranQuote() %>` to insert the quran quote into your notes (like the daily note to get a daily verse) -- **with [commander](https://github.com/phibr0/obsidian-commander)**: use it to create a button for the `Noor: Random quran quote` command +obsidian plugins complement each other, here are some ideas +- **with [templater](https://github.com/SilentVoid13/Templater)**: use `<% noorJS.randomQuranQuote() %>` to insert the Quran quote into your notes (like the daily note to get a daily verse) +- **with [commander](https://github.com/phibr0/obsidian-commander)**: use it to create a button for the `Noor: Random Quran quote` command ## Settings -- **Reciter**: choose your favorite reciter from the drop down menu -- **Translation Language**: choose the second language to show next to arabic +- **Reciter**: choose your favorite reciter from the drop-down menu +- **Translation Language**: choose the second language to show next to Arabic - **Translation Options**: choose your favorite translation from the ones available in selected **Translation Language** @@ -46,3 +46,7 @@ obsidian plugins compliment each others, here are some ideas The Quran verses are retrieved from - [alquran.cloud](https://alquran.cloud/api): An opensource Quran API made by the [Islamic Network](https://islamic.network/) ([github](https://github.com/islamic-network)) and respective [contributors](https://alquran.cloud/contributors). + + +## Contributions and suggestions +Please feel free to open a [pull request](https://github.com/MKSherbini/obsidian-noor/pulls) with suggested improvements and new feature requests diff --git a/main.ts b/main.ts index 053ce75..3bc1e79 100644 --- a/main.ts +++ b/main.ts @@ -54,7 +54,7 @@ export default class NoorPlugin extends Plugin { // This adds an editor command that can perform some operation on the current editor instance this.addCommand({ id: 'random-quran-quote', - name: 'Random quran quote', + name: 'Random Quran quote', editorCallback: async (editor: Editor, view: MarkdownView) => { editor.setSelection({line: editor.getCursor().line, ch: editor.getCursor().ch}); if (editor.getCursor().ch > 1)