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

[ENH] Updates to README for descriptions, how-to-use instructions, screenshots, and badges #447

Merged
merged 4 commits into from
Jun 16, 2023

Conversation

jarmoza
Copy link
Contributor

@jarmoza jarmoza commented Jun 13, 2023

This closes #442.

@jarmoza jarmoza added the documentation Changes only affect the documentation label Jun 13, 2023
@rmanaem rmanaem self-requested a review June 14, 2023 16:17
Copy link
Contributor

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

🍒

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jarmoza
Copy link
Contributor Author

jarmoza commented Jun 15, 2023

Okay, @rmanaem. Take another look.

Copy link
Contributor

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@jarmoza jarmoza merged commit 1887ba7 into master Jun 16, 2023
4 checks passed
@jarmoza jarmoza deleted the readme-usage-update branch June 16, 2023 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] Update documentation to include how-to-use instructions (with screenshots)
2 participants