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

adds some notes to the README #12

Merged
merged 3 commits into from
Jun 12, 2024
Merged

adds some notes to the README #12

merged 3 commits into from
Jun 12, 2024

Conversation

CBiasuzzi
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

What kind of change does this PR introduce?

docs update

What is the current behavior?

What is the new behavior (if this is a feature change)?

provide additional notes in the README file about possible installation issues

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Other information:

Signed-off-by: Christian Biasuzzi <[email protected]>
README.md Outdated Show resolved Hide resolved
@flo-dup flo-dup merged commit 4d8817a into main Jun 12, 2024
4 checks passed
@flo-dup flo-dup deleted the readme_notes branch June 12, 2024 15:00
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.

2 participants