Skip to content

Commit

Permalink
description update
Browse files Browse the repository at this point in the history
  • Loading branch information
SABER-MOHAMED committed Feb 18, 2023
1 parent f43d4ed commit 6e6747e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 44 deletions.
66 changes: 23 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 πŸ™Œ**
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 6e6747e

Please sign in to comment.