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.

Sign up for GitHub

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

Jump to bottom

docs: add high-level example. #53 #54

Merged
merged 10 commits into from
Feb 23, 2023
Merged

docs: add high-level example. #53 #54

merged 10 commits into from
Feb 23, 2023

Conversation

juliangruber
Copy link
Member

No description provided.

@juliangruber juliangruber mentioned this pull request Feb 21, 2023
Closed
6 tasks
bajtos
bajtos reviewed Feb 22, 2023
View reviewed changes
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Nice!

README.md Outdated Show resolved Hide resolved
bajtos
bajtos reviewed Feb 22, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
bajtos
bajtos reviewed Feb 22, 2023
View reviewed changes
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

I think it's better to start with Installation and then follow with Basic use (your example). That's the sequence most people will follow to try this out, isn't it?

bajtos
bajtos reviewed Feb 22, 2023
View reviewed changes
README.md Show resolved Hide resolved
bajtos
bajtos approved these changes Feb 22, 2023
View reviewed changes
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Looks mostly good 👏🏻

Please consider my two suggestions below before landing.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
juliangruber and others added 2 commits February 23, 2023 00:44
@juliangruber @bajtos
Update README.md
bb06a3c 
Co-authored-by: Miroslav Bajtoš <oss@bajtos.net>
@juliangruber @bajtos
Update README.md
e632820 
Co-authored-by: Miroslav Bajtoš <oss@bajtos.net>
bajtos
bajtos reviewed Feb 23, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
bajtos
bajtos approved these changes Feb 23, 2023
View reviewed changes
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

:shipit:

@bajtos bajtos enabled auto-merge (squash) February 23, 2023 13:41
@bajtos bajtos merged commit d5c61eb into main Feb 23, 2023
@bajtos bajtos deleted the add/docs-example branch February 23, 2023 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bajtos bajtos bajtos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@juliangruber @bajtos