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

Readme should include screenshot example #126

Closed
ZevEisenberg opened this issue Apr 28, 2023 · 5 comments · Fixed by #147
Closed

Readme should include screenshot example #126

ZevEisenberg opened this issue Apr 28, 2023 · 5 comments · Fixed by #147
Labels
documentation Improvements or additions to documentation

Comments

@ZevEisenberg
Copy link
Contributor

Someone told me about this library, and they sent me a screenshot of some example usage, and it told a super compelling story. Classic "a picture is worth a thousand words" stuff. I think if the readme had a sample screenshot at the top, it would make the use of this repo a lot easier to understand.

@ZevEisenberg
Copy link
Contributor Author

I found a bunch of examples in https://github.com/cashapp/AccessibilitySnapshot/tree/master/Example/SnapshotTests/__Snapshots__/SnapshotTestingTests that you could probably use as-is, or it might be clever to craft something a little more illustrative.

@NickEntin NickEntin added the documentation Improvements or additions to documentation label May 18, 2023
@NickEntin
Copy link
Collaborator

Thanks Zev, that's a great idea! Do you have one example in mind you think would stand out? What about using the example from the blog post announcing the framework?

@ZevEisenberg
Copy link
Contributor Author

ZevEisenberg commented May 18, 2023

That's a good one! Although for some reason, I was thinking that side-by-side would be more compelling. Something like this, but maybe smaller and with a few more controls.

But I think the one in the blog post is better than nothing.

@NickEntin NickEntin linked a pull request Aug 15, 2023 that will close this issue
@NickEntin
Copy link
Collaborator

I updated the README to include the sample snapshot from the blog post for now. I'm going to be going some more work on the documentation, so if I come up with a better example as part of that I'll update the README again.

@ZevEisenberg
Copy link
Contributor Author

It looks great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants