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

docs: update default readme for better understanding #8

Merged
merged 1 commit into from
Feb 17, 2021
Merged

Conversation

Jefiozie
Copy link
Member

@Jefiozie Jefiozie commented Feb 17, 2021

I've updated the default doc so that people better understand how to use the package.

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature (please, look at the "Scope of the project" section in the README.md file)
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@Jefiozie
Copy link
Member Author

Going to merge it straight after CI is passed

@Jefiozie Jefiozie merged commit ed77b3c into main Feb 17, 2021
@Jefiozie Jefiozie deleted the improve_docs branch February 17, 2021 20:15
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