Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refractor: optimize readme file #17

Merged
merged 3 commits into from
Mar 25, 2024
Merged

refractor: optimize readme file #17

merged 3 commits into from
Mar 25, 2024

Conversation

fabio-nettis
Copy link
Member

Description

This PR optimizes the general readability of the readme file. I deleted the entities from the readme file since they are already explained inside the postman collection.

Type of change

  • Refractor (non-breaking change which cleans up code)

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

@fabio-nettis fabio-nettis added the feature Optimizes or introduces a feature label Mar 25, 2024
@fabio-nettis fabio-nettis merged commit 238461b into main Mar 25, 2024
3 checks passed
@fabio-nettis fabio-nettis deleted the refractor/readme branch March 25, 2024 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Optimizes or introduces a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant