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

improve documentation #68

Open
ljharb opened this issue Mar 2, 2022 · 2 comments
Open

improve documentation #68

ljharb opened this issue Mar 2, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@ljharb
Copy link
Owner

ljharb commented Mar 2, 2022

We need a better readme that shows example output, and explains the green checks and red x's.
@ljharb ljharb added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 2, 2022
@ljharb ljharb mentioned this issue Mar 3, 2022
Open
@abdumamdouh
Copy link
Contributor

abdumamdouh commented Mar 11, 2022 •
edited
Loading

@ljharb
i can work on this and add md-magic to it too
can you assign this to me and @KhatiaIvanova

@KhatiaIvanova
Copy link
Contributor

@ljharb assign this issue to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ljharb @KhatiaIvanova @abdumamdouh