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: general improvements #51

Merged
merged 1 commit into from Sep 10, 2021
Merged

docs: general improvements #51

merged 1 commit into from Sep 10, 2021

Conversation

szmarczak
Copy link
Contributor

@szmarczak szmarczak commented Sep 9, 2021 •
edited

Fixes #50

@B4nan B4nan merged commit 43a9b80 into master Sep 10, 2021
@B4nan B4nan deleted the new-docs branch September 10, 2021 08:37
@mnmkng
Copy link
Member

mnmkng commented Sep 10, 2021

@szmarczak While I like short and to the point readmes, I think the stuff this package does is extremely low level and technical, so having the explanations there seemed beneficial. I think we should keep those explanatory paragraphs at some place at least.

@szmarczak
Copy link
Contributor Author

I'll send another PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@B4nan B4nan B4nan approved these changes

@mnmkng mnmkng Awaiting requested review from mnmkng

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

Successfully merging this pull request may close these issues.

update docs/readme to match v3
3 participants
@szmarczak @mnmkng @B4nan