[docs] Simple example in main README?

[spier]

I noticed that after changes in #139 the main README.md does not contain a simple workflow example any more.
I believe that this file is also used for the documentation on the GHA marketplace?

When trying out a new GitHub Action, I tend to copy and paste a simple example from the documentation, and then adapt it to my purposes from there.

To do that, I find it unhandy if such a workflow example isn't too many clicks away.

I would therefore suggest to leave at least a basic example in the main README.md.

Not sure which example workflow would be the most simple to use? Maybe this one?
https://github.com/github/issue-metrics/blob/main/docs/example-workflows.md#fixed-time-example

[Okabe-Junya]

I think it’s a great suggestion. Also, I believe this is the simplest example.

Removing the date calculation and fixing the search query would simplify things, but it might not be appropriate.

[spier]

Thank you for the confirmation @Okabe-Junya!

What would you additionally thing of adding a screenshot to the README of how the resulting issue with the metrics report looks like? Maybe based on analytics of this repo here? :)

[Okabe-Junya]

I think this is an excellent suggestion!! I am in favor of this proposal. From my research, it seems that similar actions also capture results and list them in the README.

• https://github.com/lowlighter/metrics

We may need to determine the best way to capture results and possibly update documents like CONTRIBUTING.md.

[Okabe-Junya]

@spier

May I create a PR for this issue? If you're already working on it, please let me know.

[spier]

Go for it :)

[spier]

@Okabe-Junya great changes in #145.
Looks fantastic in the marketplace as well :)

Did you decide against adding a screenshot of the resulting GitHub issue on purpose, as suggested above.
Or is this still something that might be worthwhile adding?

[Okabe-Junya]

Thank you!!

I did not include screenshots in my PR. This was because I couldn't determine which repo would be appropriate or how best to capture the screenshots. However, I do think we should consider capturing the results and including them in the README. My decision to close this issue might not have been the best one (I set it to automatically close with the PR).

Let's discuss this in a new issue.