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

Update readme #1462

Merged
merged 12 commits into from
Sep 2, 2024
Merged

Update readme #1462

merged 12 commits into from
Sep 2, 2024

Conversation

kkawula
Copy link
Collaborator

@kkawula kkawula commented Aug 30, 2024

Closes #1410

Introduced changes

  • Added examples in README.md

  • This PR contains breaking changes

@kkawula kkawula marked this pull request as draft August 30, 2024 12:16
Copy link
Collaborator

@franciszekjob franciszekjob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally it looks good, but I wonder if we could use the same content as in Quickstart section in the docs. Quickstart is something light and is suitable for README. This way, we would also maintain consistency between the examples in README <-> Docs.

Let's update Quickstart with:

image

and then use it in the README.

Wdyt @kkawula? Do you see other improvements to the Quickstart section?

@kkawula kkawula marked this pull request as ready for review September 2, 2024 10:41
@kkawula kkawula merged commit fed2346 into development Sep 2, 2024
16 checks passed
@kkawula kkawula deleted the kkawula/update-readme branch September 2, 2024 13:28
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.

Update README
2 participants