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

Easier to learn README.md #23

Merged
merged 17 commits into from Jan 31, 2021
Merged

Easier to learn README.md #23

merged 17 commits into from Jan 31, 2021

Conversation

OmarThinks
Copy link
Contributor

Examples modified

Before:

  • The example in the README.md was harder to understand.
  • It discussed the a hard topic (using request body
    and query paramters at the same time)
  • The example did not concentrate on what developers really came here for
    (getting validated data) inside the body of the function

After:

  • The example README.md is easier to understand
  • It takes baby steps towards the understanding of the package
    Example1: Query paramters only
    Example2: Request body only
    Example3: BOTH query paramters and request body
  • The examples concentrate on what developers really need the most
    (using the data inside the request function)

@sonarcloud
Copy link

sonarcloud bot commented Jan 30, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@bauerji bauerji merged commit aedfe36 into bauerji:master Jan 31, 2021
@bauerji
Copy link
Owner

bauerji commented Jan 31, 2021

Looks neat, thank you

@bauerji bauerji linked an issue Jan 31, 2021 that may be closed by this pull request
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.

Request change: the example in the main README.md file is not clear
2 participants