improve readme and update minimal example #198
Conversation
| @@ -83,61 +88,10 @@ context) properties. Like this: | |||
| ] | |||
| ``` | |||
|
|
|||
| ## Screenshots | |||
|
|
|||
There was a problem hiding this comment.
IMO, this introduction has some value to users to understand the tool. If we don't want to distract in the main doc, we can move it to separated doc and link it here. Completely deleting it may create the gap and user experience regression.
There was a problem hiding this comment.
The screenshots are still there, but I moved them to the very top (except this one https://raw.githubusercontent.com/rhysd/ss/master/github-action-benchmark/tooltip.png which I feel adds no value - people using this tool will notice on their own about this, and people that don't yet know this tool will not care about this detail).
Please checkout the readme locally and see how it looks
| run: git push 'https://you:${{ secrets.GITHUB_TOKEN }}@github.com/you/repo-name.git' gh-pages:gh-pages | ||
| ``` | ||
|
|
||
| Please add a step to push the branch to the remote. | ||
|
|
||
|
|
||
| ### Tool specific setup |
There was a problem hiding this comment.
Same. These have value to users.
There was a problem hiding this comment.
This section is repeated thrice.
- https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#github-action-for-continuous-benchmarking
- and here https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#tool-specific-setup
- and here https://github.com/benchmark-action/github-action-benchmark?tab=readme-ov-file#examples
I put everything in one place (the table). Please checkout the readme locally and see how it looks
Changes: