Skip to content

docs: improve README usage examples - #6

Open
Yashma07 wants to merge 1 commit into
Gitdigital-products:mainfrom
Yashma07:main
Open

Yashma07 wants to merge 1 commit into
Gitdigital-products:mainfrom
Yashma07:main

Conversation

@Yashma07

@Yashma07 Yashma07 commented Aug 3, 2026

Copy link
Copy Markdown

Added short descriptions to the usage

Description

Please include a summary of the change and which issue is fixed.

Fixes # (issue number) - If this PR addresses an existing issue, please link it here.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to README, contributing guidelines, etc.)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Screenshots/Gifs (if applicable)

If this is a UI change, please include screenshots or a gif demonstrating the change.

Further comments

Any additional information, context, or notes for the reviewer.

Added short descriptions to the usage

Signed-off-by: YASHMA CP <yashmayashma07@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant