From 6e6747e7fbc8c4f9279d459ce9071a525670c5ae Mon Sep 17 00:00:00 2001 From: mohamed saber Date: Sat, 18 Feb 2023 21:00:35 +0100 Subject: [PATCH] description update --- README.md | 66 ++++++++++++++++++---------------------------------- package.json | 2 +- 2 files changed, 24 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 7aac31b..08a819a 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,45 @@ -# hadith README +# Hadith ✨ -This is the README for your extension "hadith". After writing up a brief description, we recommend including the following sections. - -## Features - -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. - -For example if there is an image subfolder under your extension project workspace: - -\!\[feature X\]\(images/feature-x.png\) - -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. - -## Requirements - -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +Get a **Hadith** from the Sunnah while you're coding 💻 keep in touch with the Sayings and Teachings of **the Prophet Muhammed (ﷺ)** 🕌💚 ## Extension Settings -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. - -For example: - This extension contributes the following settings: -* `myExtension.enable`: Enable/disable this extension. -* `myExtension.thing`: Set to `blah` to do something. +- `hadith.repeatedEveryMinute`: Set notification timer. +- `hadith.language`: Set extension language. -## Known Issues +## How to configure notifications timer -Calling out known issues can help limit users opening duplicate issues against your extension. - -## Release Notes +Go to File -> select -> preference -> settings -Users appreciate release notes as you update your extension. +- Search for "Hadith" and set your own Timer & Language: -### 1.0.0 + - Default timer value is 25 minutes (Like the default pomodoro timer). + - Default language is Arabic. -Initial release of ... +## Contribute 🧑‍💻 -### 1.0.1 +Contributions are always appreciated! -Fixed issue #. +## Release Notes -### 1.1.0 +### 0.0.1 -Added features X, Y, and Z. +## Initial release of Hadith ---- +- Get random Hadith 🚀 -## Working with Markdown +- Multi Language handled (Arabic | English) 🚀 -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: +- Window | Linux | Mac Supported 🚀 -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets +## Working with Markdown -## For more information +You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) +- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux) +- Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) +- Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets -**Enjoy!** +**Enjoy 🙌** diff --git a/package.json b/package.json index c014044..ac66aff 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "hadith", "displayName": "Hadith", - "description": "Get a Hadith from the Sunnah during your coding session 💻 stay connected with Sayings and Teachings of the Prophet Muhammad (ﷺ) 🕌💚 ", + "description": "Get a Hadith from the Sunnah while you're coding 💻 keep in touch with the Sayings and Teachings of the Prophet Muhammed (ﷺ) 🕌💚", "version": "0.0.1", "icon": "", "repository": {